| Package | mx.controls |
| Class | public class FileSystemList |
| Inheritance | FileSystemList  List ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
To change the displayed data, rather than using the dataProvider property,
you set the directory property.
The control then automatically populates the dataProvider
property by enumerating the contents of that directory.
You should not set the dataProvider yourself.
You set the directory property to a File instance,
as the following example shows:
<mx: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 Syntax
The <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"
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
| ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time.
| ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| 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 | |
| backHistory : Array
[read-only]
An Array of File objects representing directories
to which the user can navigate backward.
| FileSystemList | ||
| baselinePosition : Number
[read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom.
| ScrollControlBase | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
| cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| 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 | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor.
| ListBase | |
| dataProvider : Object
Set of data to be viewed.
| ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip.
| ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
| ListBase | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| 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
Specifies whether the UIComponent object receives doubleClick events.
| UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls.
| ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation.
| ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control.
| ListBase | |
| dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| editable : Boolean = false
A flag that indicates whether or not the user can edit
items in the data provider.
| List | |
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any.
| List | |
| editedItemRenderer : IListItemRenderer
[read-only]
A reference to the item renderer
in the DataGrid control whose item is currently being edited.
| List | |
| editorDataField : String = "text"
The name of the property of the item editor that contains the new
data for the list item.
| List | |
| editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer.
| List | |
| editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key.
| List | |
| editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer.
| List | |
| editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | |
| editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| enumerationMode : String
A String specifying whether this control displays
only files, only subdirectories, or both.
| FileSystemList | ||
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| 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 | ||
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| forwardHistory : Array
[read-only]
An Array of File objects representing directories
to which the user can navigate forward.
| FileSystemList | ||
| graphics : Graphics
[read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method.
| ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge.
| ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon.
| ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon.
| ListBase | |
| id : String
ID of the component.
| UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode.
| List | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up.
| UIComponent | |
| itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true.
| List | |
| itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor,
if it exists.
| List | |
| itemRenderer : IFactory
The custom item renderer for the control.
| ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label.
| ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label.
| ListBase | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the additional data from the list control.
| ListBase | |
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released.
| ScrollControlBase | |
| loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
| ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
| ScrollControlBase | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used.
| ListBase | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| 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 | |
| numChildren : int
[read-only]
Returns the number of children of this object.
| DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control.
| ListBase | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor.
| List | |
| repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| rowCount : int
Number of rows to be displayed.
| ListBase | |
| rowHeight : Number
The height of the rows in pixels.
| ListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
| ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected.
| ListBase | |
| selectedIndex : int
The index in the data provider of the selected item.
| ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items.
| ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider.
| ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider.
| ListBase | |
| 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 | |
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
| textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| value : Object
[read-only]
The selected item, or the data or label field of the selected item.
| ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height.
| ListBase | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method.
| ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge.
| ScrollControlBase | |
| viewMetrics : EdgeMetrics
[read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible.
| ScrollControlBase | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
| ListBase | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
|
Constructor.
| FileSystemList | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running.
| ListBase | |
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point.
| DisplayObjectContainer | |
|
Returns the index where the dropped items should be added
to the drop target.
| ListBase | |
|
Queues a function to be called later.
| UIComponent | |
|
Clears this control so that it displays no items.
| FileSystemList | ||
|
Deletes a style property from this component instance.
| UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates.
| UIComponent | |
|
Converts a Point object from content to local coordinates.
| UIComponent | |
|
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property.
| List | |
|
Get the appropriate renderer, using the default renderer if none specified
| List | |
|
Creates an id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
Closes an item editor that is currently open on an item.
| List | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
Dispatches an event into the event flow.
| UIComponent | |
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
Ends all currently playing effects on the component.
| UIComponent | |
|
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
Returns the index of the File item with the specified
native file system path.
| FileSystemList | ||
|
Searches the File instances currently displayed in this control
and returns the one with the specified nativePathproperty.
| FileSystemList | ||
|
Finds an item in the list based on a String,
and moves the selection to it.
| ListBase | |
|
Called after printing is complete.
| UIComponent | |
|
Provides the automation object at the specified index.
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object.
| DisplayObject | |
|
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance.
| DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus.
| UIComponent | |
|
Return the appropriate factory, using the default factory if none specified.
| ListBase | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes.
| DisplayObject | |
|
Returns true or false
to indicates whether the effect should play on the target.
| ListBase | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated.
| UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
Converts a Point object from global to content coordinates.
| UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates.
| DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed.
| ListBase | |
|
Evaluates the display object to see if it overlaps or intersects with the
obj display object.
| DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters.
| DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient.
| UIComponent | |
|
Get an item renderer for the index of an item in the data provider,
if one exists.
| ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex.
| ListBase | |
|
Initializes the internal structure of this component.
| UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
| UIComponent | |
|
Refresh all rows on next update.
| ListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update.
| UIComponent | |
|
Determines if the item renderer for a data provider item
is editable.
| List | |
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or
or under the caret via keyboard navigation).
| ListBase | |
|
Determines if the item renderer for a data provider item
is selectable.
| ListBase | |
|
Determines if the item renderer for a data provider item
is selected.
| ListBase | |
|
Determines if an item is being displayed by a renderer.
| ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Determines whether a renderer contains (or owns) a display object.
| ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer.
| ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties.
| ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties.
| ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one.
| ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties.
| ListBase | |
|
Converts a Point object from local to content coordinates.
| UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates.
| DisplayObject | |
|
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items.
| ListBase | |
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found.
| ListBase | |
|
Moves the component to a specified position within its parent.
| UIComponent | |
|
Changes this control to display the contents of a previously-visited
directory in the backHistory array.
| FileSystemList | ||
|
Changes this control to display the contents
of the selected subdirectory.
| FileSystemList | ||
|
Changes this control to display the contents of a previously-visited
directory in the forwardHistory array.
| FileSystemList | ||
|
Changes this control to display the contents of the specified
directory.
| FileSystemList | ||
|
Changes this control to display the contents of the next directory
up in the hierarchy.
| FileSystemList | ||
|
Propagates style changes to the children.
| UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent.
| UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Re-enumerates the current directory being displayed by this control.
| FileSystemList | ||
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well.
| UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer.
| DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running.
| ListBase | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Replays the specified event.
| UIComponent | |
|
Resolves a child by using the id provided.
| UIComponent | |
|
[static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing().
| UIComponent | |
|
Ensures that the data provider item at the given index is visible.
| ListBase | |
|
Sizes the object.
| UIComponent | |
|
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
Set the current state.
| UIComponent | |
|
Sets the focus to this component.
| UIComponent | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Sets a style property on this component instance.
| UIComponent | |
|
Called when the visible property changes.
| UIComponent | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped.
| ListBase | |
|
Lets the user drag the specified sprite.
| Sprite | |
|
Ends the startDrag() method.
| Sprite | |
|
Detects changes to style properties.
| UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized.
| UIComponent | |
|
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called.
| UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
|
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control.
| ListBase | |
|
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method.
| UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements.
| UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component.
| UIComponent | |
|
Returns the primitive value of the specified object.
| Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient.
| UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when Flash Player or an AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when the user selects the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the data property changes. | ListBase | ||
| Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive. | EventDispatcher | ||
| 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 when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when the user chooses a file by double-clicking it or by selecting it and pressing Enter. | FileSystemList | |||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
| Dispatched when the editedItemPosition property is set and the item can be edited. | List | ||
| Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item. | List | ||
| Dispatched when an item editing session is ending for any reason. | List | ||
| Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. | List | ||
| Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. | List | ||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | ListBase | ||
| Dispatched when the user rolls the mouse pointer over an item in the control. | ListBase | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| 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 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 Background color of a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | ScrollControlBase | ||
| Type: Object Format: File CSS Inheritance: no Background image of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no 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: uint Format: Color CSS Inheritance: no Color of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no 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 Bounding box thickness. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | 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 Color of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no 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. | ListBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | ListBase | ||
| 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. | 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. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | 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. | 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: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| 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's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | 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 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 Direction of the drop shadow. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | 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: 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 color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | 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] 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():Array
See also
| canNavigateBack | property |
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.
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():Boolean
See also
| canNavigateDown | property |
canNavigateDown:Boolean [read-only]
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():Boolean
See also
| canNavigateForward | property |
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.
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():Boolean
See also
| canNavigateUp | property |
canNavigateUp:Boolean [read-only]
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():Boolean
See also
| directory | property |
directory:File [read-write] 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 [read-write] 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):void
See also
| extensions | property |
extensions:Array [read-write]
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 [read-write]
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] 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():Array
See also
| nameCompareFunction | property |
nameCompareFunction:Function [read-write] 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 [read-write]
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):void
See also
| selectedPaths | property |
selectedPaths:Array [read-write]
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):void
See also
| showExtensions | property |
showExtensions:Boolean [read-write]
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 [read-write]
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 [read-write]
A flag that specifies that icons are displayed
before the file name.
Set this property to true to show icons
and to false to hide them.
You can set the directoryIcon
and fileIcon styles to change the default icons.
This control cannot display the actual icon that the operating system
displays for a file, because Apollo M2 does not support that feature.
Setting this property does not affect which items are displayed, or the order in which they appear. It also does not affect which items are selected, or the scroll position.
The default value is true.
public function get showIcons():Boolean
public function set showIcons(value:Boolean):void
| FileSystemList | () | Constructor |
public function FileSystemList()
Constructor.
| clear | () | method |
public function clear():void
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
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
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
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
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
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
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
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
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.FileEvent
mx.events.FileEvent.DIRECTORY_CHANGE
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.FileEvent
mx.events.FileEvent.DIRECTORY_OPENING
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.FileEvent
mx.events.FileEvent.FILE_CHOOSE
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
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).