Packagecom.greensock.loading.core
Classpublic class DisplayObjectLoader
InheritanceDisplayObjectLoader Inheritance LoaderItem Inheritance LoaderCore Inheritance flash.events.EventDispatcher
SubclassesImageLoader, SWFLoader

Serves as the base class for SWFLoader and ImageLoader. There is no reason to use this class on its own. Please refer to the documentation for the other classes.

Copyright 2012, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html 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.
LoaderCore
 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).
LoaderCore
 InheritedbytesLoaded : uint
Bytes loaded
LoaderCore
 InheritedbytesTotal : uint
Total bytes that are to be loaded by the loader.
LoaderCore
  content : *
[read-only] A ContentDisplay object (a Sprite) that will contain the remote content as soon as the INIT event has been dispatched.
DisplayObjectLoader
  defaultAutoForceGC : Boolean = true
[static] By default, LoaderMax will automatically attempt to force garbage collection when a SWFLoader or ImageLoader is unloaded or cancelled but if you prefer to skip this measure, set defaultAutoForceGC to false.
DisplayObjectLoader
 InheritedhttpStatus : int
The httpStatus code of the loader.
LoaderItem
 InheritedloadTime : Number
The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled.
LoaderCore
 Inheritedname : String
A name that you use to identify the loader instance.
LoaderCore
 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).
LoaderCore
 Inheritedprogress : Number
A value between 0 and 1 indicating the overall progress of the loader.
LoaderCore
  rawContent : *
[read-only] The raw content that was successfully loaded into the content ContentDisplay Sprite which varies depending on the type of loader and whether or not script access was denied while attempting to load the file:
  • ImageLoader with script access granted: flash.display.Bitmap
  • ImageLoader with script access denied: flash.display.Loader
  • SWFLoader with script access granted: flash.display.DisplayObject (the swf's root)
  • SWFLoader with script access denied: flash.display.Loader (the swf's root cannot be accessed because it would generate a security error)
DisplayObjectLoader
 Inheritedrequest : URLRequest
The URLRequest associated with the loader.
LoaderItem
 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.
LoaderItem
 Inheritedstatus : int
Integer code indicating the loader's status; options are LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETED, LoaderStatus.PAUSED, and LoaderStatus.DISPOSED.
LoaderCore
 Inheritedurl : String
The url from which the loader should get its content.
LoaderItem
 Inheritedvars : Object
An object containing optional configuration details, typically passed through a constructor parameter.
LoaderCore
Public Methods
 MethodDefined by
  
DisplayObjectLoader(urlOrRequest:*, vars:Object = null)
Constructor
DisplayObjectLoader
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
LoaderCore
  
auditSize():void
Attempts loading just enough of the content to accurately determine the bytesTotal in order to improve the accuracy of the progress property.
DisplayObjectLoader
 Inherited
cancel():void
If the loader is currently loading (status is LoaderStatus.LOADING), it will be canceled immediately and its status will change to LoaderStatus.READY.
LoaderCore
 Inherited
dispose(flushContent:Boolean = false):void
Disposes of the loader and releases it internally for garbage collection.
LoaderCore
 Inherited
load(flushContent:Boolean = false):void
Loads the loader's content, optionally flushing any previously loaded content first.
LoaderCore
 Inherited
pause():void
Pauses the loader immediately.
LoaderCore
 Inherited
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.
LoaderCore
 Inherited
resume():void
Unpauses the loader and resumes loading immediately.
LoaderCore
 Inherited
toString():String
Returns information about the loader, like its type, its name, and its url (if it has one).
LoaderCore
 Inherited
unload():void
Removes any content that was loaded and sets bytesLoaded back to zero.
LoaderCore
Protected Methods
 MethodDefined by
  
_closeFallbackAudit():void
DisplayObjectLoader
  
_closeStream():void
DisplayObjectLoader
Events
 EventSummaryDefined by
 Inherited
cancel
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
complete
Dispatched when the loader completes.LoaderCore
 Inherited
error
Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR.LoaderCore
 Inherited
fail
Dispatched when the loader fails.LoaderCore
 Inherited
ioError
Dispatched when the loader experiences an IO_ERROR while loading or auditing its size.LoaderItem
 Inherited
open
Dispatched when the loader starts loading.LoaderCore
 Inherited
progress
Dispatched each time the bytesLoaded value changes while loading (indicating progress).LoaderCore
 Inherited
unload
Dispatched when the loader unloads (which happens when either unload() or dispose(true) is called or if a loader is canceled while in the process of loading).LoaderCore
Property detail
contentproperty
content:*  [read-only]

A ContentDisplay object (a Sprite) that will contain the remote content as soon as the INIT event has been dispatched. This ContentDisplay can be accessed immediately; you do not need to wait for the content to load.

Implementation
    public function get content():*
defaultAutoForceGCproperty 
public static var defaultAutoForceGC:Boolean = true

By default, LoaderMax will automatically attempt to force garbage collection when a SWFLoader or ImageLoader is unloaded or cancelled but if you prefer to skip this measure, set defaultAutoForceGC to false. If garbage collection isn't forced, sometimes Flash doesn't completely unload swfs/images properly, particularly if there is audio embedded in the root timeline.

rawContentproperty 
rawContent:*  [read-only]

The raw content that was successfully loaded into the content ContentDisplay Sprite which varies depending on the type of loader and whether or not script access was denied while attempting to load the file:

Implementation
    public function get rawContent():*
Constructor detail
DisplayObjectLoader()constructor
public function DisplayObjectLoader(urlOrRequest:*, vars:Object = null)

Constructor

Parameters
urlOrRequest:* — The url (String) or URLRequest from which the loader should get its content
 
vars:Object (default = null) — An object containing optional parameters like estimatedBytes, name, autoDispose, onComplete, onProgress, onError, etc. For example, {estimatedBytes:2400, name:"myImage1", onComplete:completeHandler}.
Method detail
_closeFallbackAudit()method
protected function _closeFallbackAudit():void
_closeStream()method 
protected override function _closeStream():void
auditSize()method 
public override function auditSize():void

Attempts loading just enough of the content to accurately determine the bytesTotal in order to improve the accuracy of the progress property. Once the bytesTotal has been determined or the auditSize() attempt fails due to an error (typically IO_ERROR or SECURITY_ERROR), the auditedSize property will be set to true. Auditing the size opens a URLStream that will be closed as soon as a response is received.