| Package | flash.events |
| Class | public class StorageVolumeChangeEvent |
| Inheritance | StorageVolumeChangeEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
StorageVolumeInfo.storageVolumeInfo object dispatches a StorageVolumeChangeEvent event
object when a storage volume is mounted or unmounted. There are two types of StorageVolumeChangeEvent:
storageVolumeMount and storageVolumeUnmount.
On Linux, the StorageVolumeInfo object only dispatches storageVolumeMount and
storageVolumeUnmount events for physical devices. It does not dispatch events when
the user mounts or unmounts volumes over a network.
Some devices, such as some digital cameras and phones, appear in the
StorageVolumeInfo.getStorageVolumes() array, but they do not dispatch StorageVolumeChangeEvent
objects when mounted or unmounted.
Related API Elements
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 | |
| rootDirectory : File [read-only]
A File object corresponding to the root directory of the mounted volume. | StorageVolumeChangeEvent | ||
| storageVolume : StorageVolume [read-only]
A StorageVolume object containing information about a mounted volume. | StorageVolumeChangeEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null)
Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners. | StorageVolumeChangeEvent | ||
[override]
Duplicates an instance of an Event subclass. | StorageVolumeChangeEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string containing all the properties of the Event object. | StorageVolumeChangeEvent | ||
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| STORAGE_VOLUME_MOUNT : String = "storageVolumeMount" [static]
The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the
type property of a StorageVolumeChangeEvent when a volume is mounted. | StorageVolumeChangeEvent | ||
| STORAGE_VOLUME_UNMOUNT : String = "storageVolumeUnmount" [static]
The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the
type property of a StorageVolumeChangeEvent when a volume is unmounted. | StorageVolumeChangeEvent | ||
rootDirectory | property |
rootDirectory:File [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
A File object corresponding to the root directory of the mounted volume.
If the volume has been unmounted (if the event type is storageVolumeUnmount,
this property is set to null.
Implementation
public function get rootDirectory():FileRelated API Elements
storageVolume | property |
storageVolume:StorageVolume [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
A StorageVolume object containing information about a mounted volume. This property is null
for an unmounted volume (for an storageVolumeUnmount event).
Implementation
public function get storageVolume():StorageVolumeRelated API Elements
StorageVolumeChangeEvent | () | Constructor |
public function StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners.
Parameterstype:String — The type of the event, accessible in the type property.
The StorageVolumeChangeEvent class defines two event types, the storageVolumeMount event,
represented by the StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT constant, and the
storageVolumeUnmount event, represented by the StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT
constant,
| |
bubbles:Boolean (default = false)false.
| |
cancelable:Boolean (default = false)false.
| |
path:File (default = null) | |
volume:StorageVolume (default = null) |
Related API Elements
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Duplicates an instance of an Event subclass.
Returns a new Event object that is a copy of the original instance of the Event object.
You do not normally call clone(); the EventDispatcher class calls it automatically
when you redispatch an event—that is, when you call dispatchEvent(event) from a handler
that is handling event.
The new Event object includes all the properties of the original.
When creating your own custom Event class, you must override the
inherited Event.clone() method in order for it to duplicate the
properties of your custom class. If you do not set all the properties that you add
in your event subclass, those properties will not have the correct values when listeners
handle the redispatched event.
In this example, PingEvent is a subclass of Event
and therefore implements its own version of clone().
class PingEvent extends Event {
var URL:String;
public override function clone():Event {
return new PingEvent(type, bubbles, cancelable, URL);
}
}
Event — A new Event object that is identical to the original.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Returns a string containing all the properties of the Event object. The string is in the following format:
[Event type=value bubbles=value cancelable=value]
String — A string containing all the properties of the Event object.
|
STORAGE_VOLUME_MOUNT | Constant |
public static const STORAGE_VOLUME_MOUNT:String = "storageVolumeMount"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the
type property of a StorageVolumeChangeEvent when a volume is mounted.
The event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The StorageVolumeChangeEvent object. |
file | A File object representing the storage volume. |
name | The name of the storage volume. |
target | The StorageVolumeChangeEvent object. |
type | "storageVolumeMount" |
Related API Elements
STORAGE_VOLUME_UNMOUNT | Constant |
public static const STORAGE_VOLUME_UNMOUNT:String = "storageVolumeUnmount"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the
type property of a StorageVolumeChangeEvent when a volume is unmounted.
The event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The StorageVolumeChangeEvent object. |
file | A File object representing the storage volume. |
name | The name of the storage volume. |
target | The StorageVolumeChangeEvent object. |
type | "storageVolumeUnmount" |
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00