org.osmf.events

# LoadEvent - AS3 OSMF FLEXOSMF

Package | org.osmf.events
Class | public class LoadEvent
Inheritance | LoadEvent Event 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | bytes : Number [read-only] New value of bytesLoaded or bytesTotal. | LoadEvent
|  | 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
|  | loadState : String [read-only] New LoadState of the LoadTrait. | LoadEvent
|  | 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
--- | --- | ---
|  | LoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, loadState:String = null, bytes:Number = NaN) Constructor. | LoadEvent
|  | 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
--- | --- | ---
|  | 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.

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