Classpublic class SelfLoader
InheritanceSelfLoader Inheritance LoaderItem Inheritance LoaderCore Inheritance

Tracks the loading progress of the swf in which the loader resides (basically a simple tool for tracking the loaderInfo's progress). SelfLoader is only useful in situations where you want to factor the current swf's loading progress into a LoaderMax queue or maybe display a progress bar for the current swf or fire an event when loading has finished.

The following special properties can be passed into the SelfLoader constructor via its vars parameter:

Example AS3 code:
 import com.greensock.loading.*;
//create a SelfLoader
var loader:SelfLoader = new SelfLoader(this, {name:"self", onProgress:progressHandler, onComplete:completeHandler});

//Or you could put the SelfLoader into a LoaderMax. Create one first...
var queue:LoaderMax = new LoaderMax({name:"mainQueue", onProgress:progressHandler, onComplete:completeHandler, onError:errorHandler});

//append the SelfLoader and several other loaders
queue.append( loader );
queue.append( new ImageLoader("images/photo1.jpg", {name:"photo1", container:this}) );
queue.append( new SWFLoader("swf/child.swf", {name:"child", container:this, x:100, estimatedBytes:3500}) );

//start loading the LoaderMax queue

function progressHandler(event:LoaderEvent):void {
 trace("progress: " +;

function completeHandler(event:LoaderEvent):void {
 trace( + " complete");

function errorHandler(event:LoaderEvent):void {
 trace("error occured with " + + ": " + event.text);
Copyright 2010, GreenSock. All rights reserved. This work is subject to the terms in or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.

Public Properties
 PropertyDefined by
 InheritedauditedSize : Boolean
Indicates whether or not the loader's bytesTotal value has been set by any of the following:
  • Defining an estimatedBytes in the vars object passed to the constructor
  • Calling auditSize() and getting a response (an error is also considered a response)
  • When a LoaderMax instance begins loading, it will automatically force a call to auditSize() for any of its children that don't have an estimatedBytes defined.
 InheritedautoDispose : Boolean
When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event).
 InheritedbytesLoaded : uint
Bytes loaded
 InheritedbytesTotal : uint
Total bytes that are to be loaded by the loader.
 Inheritedcontent : *
The content that was loaded by the loader which varies by the type of loader:
  • ImageLoader - A com.greensock.loading.display.ContentDisplay (a Sprite) which contains the ImageLoader's rawContent (a flash.display.Bitmap unless script access was denied in which case rawContent will be a flash.display.Loader to avoid security errors).
 InheritedhttpStatus : int
The httpStatus code of the loader.
 InheritedloadTime : Number
The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled.
 Inheritedname : String
A name that you use to identify the loader instance.
 Inheritedpaused : Boolean
If a loader is paused, its progress will halt and any LoaderMax instances to which it belongs will either skip over it or stop when its position is reached in the queue (depending on whether or not the LoaderMax's skipPaused property is true).
 Inheritedprogress : Number
A value between 0 and 1 indicating the overall progress of the loader.
 Inheritedrequest : URLRequest
The URLRequest associated with the loader.
 InheritedscriptAccessDenied : Boolean
If the loaded content is denied script access (because of security sandbox restrictions, a missing crossdomain.xml file, etc.), scriptAccessDenied will be set to true.
 Inheritedstatus : int
Integer code indicating the loader's status; options are LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETE, LoaderStatus.PAUSED, and LoaderStatus.DISPOSED.
 Inheritedurl : String
The url from which the loader should get its content.
 Inheritedvars : Object
An object containing optional configuration details, typically passed through a constructor parameter.
Public Methods
 MethodDefined by
SelfLoader(self:DisplayObject, vars:Object = null)
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Attempts loading just enough of the content to accurately determine the bytesTotal in order to improve the accuracy of the progress property.
If the loader is currently loading (status is LoaderStatus.LOADING), it will be canceled immediately and its status will change to LoaderStatus.READY.
dispose(flushContent:Boolean = false):void
Disposes of the loader and releases it internally for garbage collection.
load(flushContent:Boolean = false):void
Loads the loader's content, optionally flushing any previously loaded content first.
Pauses the loader immediately.
prioritize(loadNow:Boolean = true):void
Immediately prioritizes the loader inside any LoaderMax instances that contain it, forcing it to the top position in their queue and optionally calls load() immediately as well.
Unpauses the loader and resumes loading immediately.
Returns information about the loader, like its type, its name, and its url (if it has one).
Removes any content that was loaded and sets bytesLoaded back to zero.
Protected Methods
 MethodDefined by
 EventSummaryDefined by
 Inherited Dispatched when the loader is canceled while loading which can occur either because of a failure or when a sibling loader is prioritized in a LoaderMax queue.LoaderCore
 Inherited Dispatched when the loader completes.LoaderCore
 Inherited Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR.LoaderCore
 Inherited Dispatched when the loader fails.LoaderCore
 Inherited Dispatched when the loader experiences an IO_ERROR while loading or auditing its size.LoaderItem
 Inherited Dispatched when the loader starts loading.LoaderCore
 Inherited Dispatched each time the bytesLoaded value changes while loading (indicating progress).LoaderCore
Constructor detail
public function SelfLoader(self:DisplayObject, vars:Object = null)


self:DisplayObject — A DisplayObject from the main swf (it will use this DisplayObject's loaderInfo to track the loading progress).
vars:Object (default = null) — An object containing optional configuration details. For example: new SelfLoader(this, {name:"self", onComplete:completeHandler, onProgress:progressHandler}).

The following special properties can be passed into the constructor via the vars parameter:
  • name : String - A name that is used to identify the loader instance. This name can be fed to the LoaderMax.getLoader() or LoaderMax.getContent() methods or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".
  • autoDispose : Boolean - When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError). Once a loader is disposed, it can no longer be found with LoaderMax.getLoader() or LoaderMax.getContent(). The default autoDispose value is false.

  • onProgress : Function - A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. Make sure your onProgress function accepts a single parameter of type LoaderEvent ( You can use the LoaderEvent's target.progress to get the loader's progress value or use its target.bytesLoaded and target.bytesTotal.
  • onComplete : Function - A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type LoaderEvent (