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

FileEvent  - AS3 Flex
Packagemx.events
Classpublic class FileEvent
InheritanceFileEvent Inheritance Event Inheritance 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
 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
      file : File
The File instance associated with this event.
FileEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    FileEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, file:File = null)
Constructor.
FileEvent
 Inherited
clone():Event
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
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFileEvent.DIRECTORY_CHANGE
    

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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFileEvent.DIRECTORY_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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFileEvent.DIRECTORY_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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFileEvent.DIRECTORY_OPENING
    

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFileEvent.FILE_CHOOSE



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy