mx.events

# FileEvent - AS3 Flex

Package | mx.events
Class | public class FileEvent
Inheritance | FileEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The FileEvent class represents event objects that are specific to the FileSystemList, FileSystemDataGrid, FileSystemTree and FileSystemComboBox controls.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.controls.FileSystemComboBox
mx.controls.FileSystemDataGrid
mx.controls.FileSystemList
mx.controls.FileSystemTree

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | file : File The File instance associated with this event. | FileEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FileEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, file:File = null) Constructor. | FileEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DIRECTORY_CHANGE : String = "directoryChange" [static] The FileEvent.DIRECTORY_CHANGE constant defines the value of the type property of the event object for a directoryChange event. | FileEvent
|  | DIRECTORY_CHANGING : String = "directoryChanging" [static] The FileEvent.DIRECTORY_CHANGING constant defines the value of the type property of the event object for a directoryChanging event. | FileEvent
|  | DIRECTORY_CLOSING : String = "directoryClosing" [static] The FileEvent.DIRECTORY_CLOSING constant defines the value of the type property of the event object for a directoryClosing event. | FileEvent
|  | DIRECTORY_OPENING : String = "directoryOpening" [static] The FileEvent.DIRECTORY_OPENING constant defines the value of the type property of the event object for a directoryOpening event. | FileEvent
|  | FILE_CHOOSE : String = "fileChoose" [static] The FileEvent.FILE_CHOOSE constant defines the value of the type property of the event object for a fileChoose event. | FileEvent

Property Detail

### file

property

`public var file:File`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The File instance associated with this event.

Constructor Detail

### FileEvent

()
Constructor

`public function FileEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, file:File = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.
| `file:File` (default = `null`)`` — The File instance associated with this event.

Constant Detail

### DIRECTORY_CHANGE

Constant

`public static const DIRECTORY_CHANGE:String = "directoryChange"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

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

The properties of the event object have the following values:

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

### DIRECTORY_CHANGING

Constant

`public static const DIRECTORY_CHANGING:String = "directoryChanging"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The FileEvent.DIRECTORY_CHANGING constant defines the value of the `type` property of the event object for a `directoryChanging` 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_CHANGING

### DIRECTORY_CLOSING

Constant

`public static const DIRECTORY_CLOSING:String = "directoryClosing"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The FileEvent.DIRECTORY_CLOSING constant defines the value of the `type` property of the event object for a `directoryClosing` 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_CLOSING

### DIRECTORY_OPENING

Constant

`public static const DIRECTORY_OPENING:String = "directoryOpening"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

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

The properties of the event object have the following values:

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

### FILE_CHOOSE

Constant

`public static const FILE_CHOOSE:String = "fileChoose"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

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

The properties of the event object have the following values:

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00