ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

FileListEvent  - AS3

Packageflash.events
Classpublic class FileListEvent
InheritanceFileListEvent Inheritance Event Inheritance Object

Runtime Versions: AIR 1.0

A File object dispatches a FileListEvent object when a call to the getDirectoryListingAsync() method of a File object successfully enumerates a set of files and directories or when a user selects files after a call to the browseForOpenMultiple() method.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
      files : Array
An array of File objects representing the files and directories found or selected.
FileListEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    FileListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, files:Array = null)
The constructor function for a FileListEvent object.
FileListEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      DIRECTORY_LISTING : String = "directoryListing"
[static] The FileListEvent.DIRECTORY_LISTING constant defines the value of the type property of the event object for a directoryListing event.
FileListEvent
      SELECT_MULTIPLE : String = "selectMultiple"
[static] The FileListEvent.SELECT_MULTIPLE constant defines the value of the type property of the event object for a selectMultiple event.
FileListEvent
Property Detail
    

files

property
public var files:Array

Runtime Versions: AIR 1.0

An array of File objects representing the files and directories found or selected.

For the File.getDirectoryListingAsync() method, this is the list of files and directories found at the root level of the directory represented by the File object that called the method. For the File.browseForOpenMultiple() method, this is the list of files selected by the user.

Constructor Detail
    

FileListEvent

()Constructor
public function FileListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, files:Array = null)

Runtime Versions: AIR 1.0

The constructor function for a FileListEvent object.

The runtime uses this class to create FileListEvent objects. You will not use this constructor directly in your code.

Parameters
type:String — The type of the event.
 
bubbles:Boolean (default = false) — Determines whether the event object bubbles (false for a FileListEvent object).
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled (false for a FileListEvent object).
 
files:Array (default = null) — An array of File objects.
Constant Detail
    

DIRECTORY_LISTING

Constant
public static const DIRECTORY_LISTING:String = "directoryListing"

Runtime Versions: AIR 1.0

The FileListEvent.DIRECTORY_LISTING constant defines the value of the type property of the event object for a directoryListing event.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files and directories found.
targetThe FileListEvent object.
    

SELECT_MULTIPLE

Constant 
public static const SELECT_MULTIPLE:String = "selectMultiple"

Runtime Versions: AIR 1.0

The FileListEvent.SELECT_MULTIPLE constant defines the value of the type property of the event object for a selectMultiple event.

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files selected.
targetThe FileListEvent object.