Flash Lite 2.x and 3.0 ActionScript Language Reference

MovieClipLoader 

Object
    |
    +-MovieClipLoader

public class MovieClipLoader
extends Object

The MovieClipLoader class lets you implement listener callbacks that provide status information while SWF, JPEG, GIF, and PNG files are being loaded (downloaded) into movie clips. To use MovieClipLoader features, use MovieClipLoader.loadClip() instead of loadMovie() or MovieClip.loadMovie() to load SWF files.

After you issue the MovieClipLoader.loadClip() method, the following events take place in the order listed:

  • When the first bytes of the downloaded file are written to disk, the MovieClipLoader.onLoadStart listener is invoked.
  • If you implemented the MovieClipLoader.onLoadProgress listener, it is invoked during the loading process.
    Note: You can call MovieClipLoader.getProgress() at any time during the load process.
  • When the entire downloaded file is written to disk, the MovieClipLoader.onLoadComplete listener is invoked.
  • After the downloaded file's first frame actions are executed, the MovieClipLoader.onLoadInit listener is invoked.

After MovieClipLoader.onLoadInit is invoked, you can set properties, use methods, and otherwise interact with the loaded movie.

If the file fails to load completely, the MovieClipLoader.onLoadError listener is invoked.

Property summary

Properties inherited from class Object

constructor (Object.constructor property), __proto__ (Object.__proto__ property), prototype (Object.prototype property), __resolve (Object.__resolve property)

Event summary

Event

Description

onLoadComplete = function(listenerObject, [target_mc]) {}

Invoked when a file loaded with MovieClipLoader.loadClip() is completely downloaded.

onLoadError = function(target_mc, errorCode) {}

Invoked when a file loaded with MovieClipLoader.loadClip() has failed to load.

onLoadInit = function([target_mc]) {}

Invoked when the actions on the first frame of the loaded clip are executed.

onLoadProgress = function([target_mc], loadedBytes, totalBytes) {}

Invoked every time the loading content is written to disk during the loading process (that is, between MovieClipLoader.onLoadStart and MovieClipLoader.onLoadComplete).

onLoadStart = function([target_mc]) {}

Invoked when a call to MovieClipLoader.loadClip() has successfully begun to download a file.

Constructor summary

Signature

Description

MovieClipLoader()

Creates a MovieClipLoader object that you can use to implement a number of listeners to respond to events while a SWF, JPEG, GIF, or PNG file is downloading.

Method summary

Modifiers

Signature

Description

 

addListener(listener:Object) : Boolean

Registers an object to receive notification when a MovieClipLoader event handler is invoked.

 

getProgress(target:Object) : Object

Returns the number of bytes loaded and total number of bytes for a file that is being loaded by using MovieClipLoader.loadClip(); for compressed movies, the getProgress method reflects the number of compressed bytes.

 

loadClip(url:String, target:Object) : Boolean

Loads a SWF or JPEG file into a movie clip in Flash Player while the original movie is playing.

 

removeListener(listener:Object) : Boolean

Removes the listener that was used to receive notification when a MovieClipLoader event handler was invoked.

 

unloadClip(target:Object) : Boolean

Removes a movie clip that was loaded by means of MovieClipLoader.loadClip().

Methods inherited from class Object

addProperty (Object.addProperty method), hasOwnProperty (Object.hasOwnProperty method), isPropertyEnumerable (Object.isPropertyEnumerable method), isPrototypeOf (Object.isPrototypeOf method), registerClass (Object.registerClass method), toString (Object.toString method), unwatch (Object.unwatch method), valueOf (Object.valueOf method), watch (Object.watch method)