|Class||public class DisplayObjectLoader|
|Inheritance||DisplayObjectLoader LoaderItem LoaderCore flash.events.EventDispatcher|
Copyright 2013, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for Club GreenSock members, the software agreement that was issued with the membership.
|auditedSize : Boolean|
[read-only] 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.
|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).
|bytesLoaded : uint|
[read-only] Bytes loaded
|bytesTotal : uint|
[read-only] Total bytes that are to be loaded by the loader.
|content : *|
[override] [read-only] A ContentDisplay object (a Sprite) that will contain the remote content as soon as the INIT event has been dispatched.
|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.
|httpStatus : int|
[read-only] The httpStatus code of the loader.
|loadTime : Number|
[read-only] The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled.
|name : String|
A name that you use to identify the loader instance.
|paused : 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).
|progress : Number|
[read-only] A value between 0 and 1 indicating the overall progress of the loader.
|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)
|request : URLRequest|
[read-only] The URLRequest associated with the loader.
|scriptAccessDenied : Boolean|
[read-only] 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.
|status : int|
[read-only] Integer code indicating the loader's status; options are LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETED, LoaderStatus.PAUSED, and LoaderStatus.DISPOSED.
|url : String|
The url from which the loader should get its content.
|vars : Object|
An object containing optional configuration details, typically passed through a constructor parameter.
DisplayObjectLoader(urlOrRequest:*, vars:Object = null)
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] 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.
[override] 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.
|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|
|Dispatched when the loader completes.||LoaderCore|
|Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR.||LoaderCore|
|Dispatched when the loader fails.||LoaderCore|
|Dispatched when the loader experiences an IO_ERROR while loading or auditing its size.||LoaderItem|
|Dispatched when the loader starts loading.||LoaderCore|
|Dispatched each time the bytesLoaded value changes while loading (indicating progress).||LoaderCore|
|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|
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.
public function get content():*
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.
The raw content that was successfully loaded into the
Sprite which varies depending on the type of loader and whether or not script access was denied while
attempting to load the file:
rootcannot be accessed because it would generate a security error)
public function get rawContent():*
public function DisplayObjectLoader(urlOrRequest:*, vars:Object = null)
protected function _closeFallbackAudit():void
override protected function _closeStream():void
override public function auditSize():void
Attempts loading just enough of the content to accurately determine the
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
true. Auditing the size opens a URLStream that will be closed
as soon as a response is received.