Packagecom.greensock.loading.core
Classpublic class LoaderItem
InheritanceLoaderItem Inheritance LoaderCore Inheritance flash.events.EventDispatcher
SubclassesDataLoader, DisplayObjectLoader, MP3Loader, SelfLoader, VideoLoader

Serves as the base class for all individual loaders (not LoaderMax) like ImageLoader, XMLLoader, SWFLoader, MP3Loader, etc. There is no reason to use this class on its own. Please see the documentation for the other classes.

Copyright 2010, 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
 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).
LoaderCore
  httpStatus : int
[read-only] 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
  request : URLRequest
[read-only] The URLRequest associated with the loader.
LoaderItem
  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.
LoaderItem
 Inheritedstatus : int
Integer code indicating the loader's status; options are LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETE, LoaderStatus.PAUSED, and LoaderStatus.DISPOSED.
LoaderCore
  url : 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
  
LoaderItem(urlOrRequest:*, vars:Object = null)
Constructor
LoaderItem
 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.
LoaderItem
 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
  
_applyCacheBuster():void
LoaderItem
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
  
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
Property detail
httpStatusproperty
httpStatus:int  [read-only]

The httpStatus code of the loader. You may listen for LoaderEvent.HTTP_STATUS events on certain types of loaders to be notified when it changes, but in some environments the Flash player cannot sense httpStatus codes in which case the value will remain 0.

Implementation
    public function get httpStatus():int
requestproperty 
request:URLRequest  [read-only]

The URLRequest associated with the loader.

Implementation
    public function get request():URLRequest
scriptAccessDeniedproperty 
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. In the case of loaded images or swf files, this means that you should not attempt to perform BitmapData operations on the content. An image's smoothing property cannot be set to true either. Even if script access is denied for particular content, LoaderMax will still attempt to load it.

Implementation
    public function get scriptAccessDenied():Boolean
urlproperty 
url:String  [read-write]

The url from which the loader should get its content.

Implementation
    public function get url():String
    public function set url(value:String):void
Constructor detail
LoaderItem()constructor
public function LoaderItem(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
_applyCacheBuster()method
protected function _applyCacheBuster():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.

Event detail
ioErrorevent 
Event object type: com.greensock.events.LoaderEvent

Dispatched when the loader experiences an IO_ERROR while loading or auditing its size.