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 

LoaderEvent  - AS3 OSMF

Packageorg.osmf.events
Classpublic class LoaderEvent
InheritanceLoaderEvent Inheritance Event Inheritance Object

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

A LoaderBase dispatches a LoaderEvent when a LoadTrait that it's loading or unloading undergoes a notable load-oriented change.



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
  loader : LoaderBase
[read-only] The loader for this event.
LoaderEvent
  loadTrait : org.osmf.traits:LoadTrait
[read-only] The LoadTrait for this event.
LoaderEvent
  newState : String
[read-only] The new state of the LoadTrait.
LoaderEvent
  oldState : String
[read-only] The previous state of the LoadTrait.
LoaderEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
LoaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, loader:LoaderBase = null, loadTrait:org.osmf.traits:LoadTrait = null, oldState:String = null, newState:String = null)
Constructor.
LoaderEvent
 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
  LOAD_STATE_CHANGE : String = "loadStateChange"
[static] The LoaderEvent.LOAD_STATE_CHANGE constant defines the value of the type property of the event object for a loadStateChange event.
LoaderEvent
Property Detail

loader

property
loader:LoaderBase  [read-only]

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

The loader for this event.



Implementation
    public function get loader():LoaderBase

loadTrait

property 
loadTrait:org.osmf.traits:LoadTrait  [read-only]

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

The LoadTrait for this event.



Implementation
    public function get loadTrait():org.osmf.traits:LoadTrait

newState

property 
newState:String  [read-only]

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

The new state of the LoadTrait.



Implementation
    public function get newState():String

oldState

property 
oldState:String  [read-only]

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

The previous state of the LoadTrait.



Implementation
    public function get oldState():String
Constructor Detail

LoaderEvent

()Constructor
public function LoaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, loader:LoaderBase = null, loadTrait:org.osmf.traits:LoadTrait = null, oldState:String = null, newState:String = null)

Language Version: ActionScript 3.0
Product Version: OSMF 1.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.
 
loader:LoaderBase (default = null) — The LoaderBase for this event.
 
loadTrait:org.osmf.traits:LoadTrait (default = null) — The LoadTrait for this event.
 
oldState:String (default = null) — The previous state of the loadTrait.
 
newState:String (default = null) — The new state of the loadTrait.
Constant Detail

LOAD_STATE_CHANGE

Constant
public static const LOAD_STATE_CHANGE:String = "loadStateChange"

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

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