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

LoadEvent  - AS3 OSMF FLEXOSMF

Packageorg.osmf.events
Classpublic class LoadEvent
InheritanceLoadEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

A LoadEvent is dispatched when the properties of a LoadTrait change.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
  bytes : Number
[read-only] New value of bytesLoaded or bytesTotal.
LoadEvent
 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
  loadState : String
[read-only] New LoadState of the LoadTrait.
LoadEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
LoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, loadState:String = null, bytes:Number = NaN)
Constructor.
LoadEvent
 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
  BYTES_LOADED_CHANGE : String = "bytesLoadedChange"
[static] The LoadEvent.BYTES_LOADED_CHANGE constant defines the value of the type property of the event object for a bytesLoadedChange event.
LoadEvent
  BYTES_TOTAL_CHANGE : String = "bytesTotalChange"
[static] The LoadEvent.BYTES_TOTAL_CHANGE constant defines the value of the type property of the event object for a bytesTotalChange event.
LoadEvent
  LOAD_STATE_CHANGE : String = "loadStateChange"
[static] The LoadEvent.LOAD_STATE_CHANGE constant defines the value of the type property of the event object for a loadStateChange event.
LoadEvent
Property Detail

bytes

property
bytes:Number  [read-only]

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

New value of bytesLoaded or bytesTotal.



Implementation
    public function get bytes():Number

loadState

property 
loadState:String  [read-only]

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

New LoadState of the LoadTrait.



Implementation
    public function get loadState():String
Constructor Detail

LoadEvent

()Constructor
public function LoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, loadState:String = null, bytes:Number = NaN)

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
type:String — Event type.
 
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.
 
loadState:String (default = null) — New LoadState of the LoadTrait.
 
bytes:Number (default = NaN) — New value of bytesLoaded or bytesTotal. Returns NaN when media is unloaded.
Constant Detail

BYTES_LOADED_CHANGE

Constant
public static const BYTES_LOADED_CHANGE:String = "bytesLoadedChange"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The LoadEvent.BYTES_LOADED_CHANGE constant defines the value of the type property of the event object for a bytesLoadedChange event.

BYTES_TOTAL_CHANGE

Constant 
public static const BYTES_TOTAL_CHANGE:String = "bytesTotalChange"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The LoadEvent.BYTES_TOTAL_CHANGE constant defines the value of the type property of the event object for a bytesTotalChange event.

LOAD_STATE_CHANGE

Constant 
public static const LOAD_STATE_CHANGE:String = "loadStateChange"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The LoadEvent.LOAD_STATE_CHANGE constant defines the value of the type property of the event object for a loadStateChange event.