API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class DisplayObjectLoader

Package | com.greensock.loading.core
Class | public class DisplayObjectLoader
Inheritance | DisplayObjectLoader LoaderItem LoaderCore flash.events.EventDispatcher
Subclasses | ImageLoader, 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 2011, 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | auditedSize : 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
|  | 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). | LoaderCore
|  | bytesLoaded : uint Bytes loaded | LoaderCore
|  | bytesTotal : 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
|  | httpStatus : int The httpStatus code of the loader. | LoaderItem
|  | loadTime : Number The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled. | LoaderCore
|  | name : String A name that you use to identify the loader instance. | LoaderCore
|  | 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`). | LoaderCore
|  | progress : 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
|  | request : URLRequest The `URLRequest` associated with the loader. | LoaderItem
|  | scriptAccessDenied : 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
|  | status : int Integer code indicating the loader's status; options are `LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETED, LoaderStatus.PAUSED,` and `LoaderStatus.DISPOSED`. | LoaderCore
|  | url : String The url from which the loader should get its content. | LoaderItem
|  | vars : Object An object containing optional configuration details, typically passed through a constructor parameter. | LoaderCore

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | DisplayObjectLoader(urlOrRequest:*, vars:Object = null) Constructor | DisplayObjectLoader
|  | 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. | LoaderItem
|  | 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
|  | dispose(flushContent:Boolean = false):void Disposes of the loader and releases it internally for garbage collection. | LoaderCore
|  | load(flushContent:Boolean = false):void Loads the loader's content, optionally flushing any previously loaded content first. | LoaderCore
|  | pause():void Pauses the loader immediately. | LoaderCore
|  | 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
|  | resume():void Unpauses the loader and resumes loading immediately. | LoaderCore
|  | toString():String Returns information about the loader, like its type, its `name`, and its `url` (if it has one). | LoaderCore
|  | unload():void Removes any content that was loaded and sets `bytesLoaded` back to zero. | LoaderCore

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined by
--- | --- | --- | ---
|  | 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
|  | complete | Dispatched when the loader completes. | LoaderCore
|  | error | Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR. | LoaderCore
|  | fail | Dispatched when the loader fails. | LoaderCore
|  | ioError | Dispatched when the loader experiences an IO_ERROR while loading or auditing its size. | LoaderItem
|  | open | Dispatched when the loader starts loading. | LoaderCore
|  | progress | Dispatched each time the `bytesLoaded` value changes while loading (indicating progress). | LoaderCore
|  | 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

content | property

`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():*`

rawContent | property |

`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)

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}`.