Main Page | Packages | Class Tree | Index | Help

xp.events

class ContentLoaderListener

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.events.ContentLoaderListener


class ContentLoaderListener
extends DispatcherObject

ContentLoaderListener

ContentLoaderListener implements 2 separate interfaces:
MovieClipLoader interface - onLoadComplete/onLoadError/onLoadInit/onLoadProgress/onLoadStart
Loader interface - complete/progress
This enables it to be used with any loading component, it translates these different interfaces into a single
event API. Its emits the "progress" event with subtypes covering the various stages
loadError/loadStart/loadProgress/loadComplete/loadInit

Usage:
mcl = new MovieClipLoader(); cll = new ContentLoaderListener(this); cll.addEventListener("progress", this, "onProgressHandler"); mcl.addListener(cll);


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Fields inherited from class xp.system.DispatcherObject

parent

Constructor

public
ContentLoaderListener ( container)
Constructor

Method Summary

public
complete ( e: Event )
Callback for the loader complete event

public
getBytesLoaded ( ): Number
Read only bytes currently loaded

public
getBytesTotal ( ): Number
Read only total bytes to be loaded

public
onLoadComplete ( target_mc: MovieClip )
Callback for the MovieClipLoader OnLoadComplete event

public
onLoadError ( target_mc: MovieClip, errorCode: String )
Callback for the MovieClipLoader onLoadError event

public
onLoadInit ( target_mc: MovieClip )
Callback for the MovieClipLoader onLoadInit event

public
onLoadProgress ( target_mc: MovieClip, loadedBytes: Number, totalBytes: Number )
Callback for the MovieClipLoader onLoadProgress event

public
onLoadStart ( target_mc: MovieClip )
Callback for the MovieClipLoader onLoadStart event

public
progress ( e: Event )
Callback for the loader progress event

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent



Constructor Documentation

ContentLoaderListener

public function ContentLoaderListener(container)
Constructor

Parameters:
container
The container or component into which content is being loaded

Method Documentation

complete

public function complete(e: Event)
Callback for the loader complete event

getBytesLoaded

public function getBytesLoaded(): Number
Read only bytes currently loaded

getBytesTotal

public function getBytesTotal(): Number
Read only total bytes to be loaded

onLoadComplete

public function onLoadComplete(target_mc: MovieClip)
Callback for the MovieClipLoader OnLoadComplete event

onLoadError

public function onLoadError(target_mc: MovieClip,
 errorCode: String)
Callback for the MovieClipLoader onLoadError event

onLoadInit

public function onLoadInit(target_mc: MovieClip)
Callback for the MovieClipLoader onLoadInit event

onLoadProgress

public function onLoadProgress(target_mc: MovieClip,
 loadedBytes: Number,
 totalBytes: Number)
Callback for the MovieClipLoader onLoadProgress event

onLoadStart

public function onLoadStart(target_mc: MovieClip)
Callback for the MovieClipLoader onLoadStart event

progress

public function progress(e: Event)
Callback for the loader progress event


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc