Packagecom.greensock.loading.data
Classpublic dynamic class XMLLoaderVars
InheritanceXMLLoaderVars Inheritance LoaderItemVars Inheritance LoaderCoreVars

Can be used instead of a generic object to define the vars parameter of an XMLLoader's constructor.

There are 2 primary benefits of using a XMLLoaderVars instance to define your XMLLoader variables:
  1. In most code editors, code hinting will be activated which helps remind you which special properties are available in XMLLoader
  2. It enables strict data typing for improved debugging (ensuring, for example, that you don't define a Boolean value for onComplete where a Function is expected).
USAGE:

Instead of new XMLLoader("getData.php", {name:"myData", estimatedBytes:1500, onComplete:completeHandler, onProgress:progressHandler}), you could use this utility like:

var vars:XMLLoaderVars = new XMLLoaderVars();
vars.name = "myData";
vars.estimatedBytes = 1500;
vars.onComplete = completeHandler;
vars.onProgress = progressHandler;
var loader:XMLLoader = new XMLLoader("getData.php", vars);

 Some of the most common properties can be defined directly in the constructor like this:

var loader:XMLLoader = new XMLLoader("getData.php", new XMLLoaderVars("myData", 1500, completeHandler, progressHandler) );

 NOTE: Using XMLLoaderVars is completely optional. If you prefer the shorter synatax with the generic Object, feel free to use it. The purpose of this class is simply to enable code hinting and to allow for strict data typing.

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
 InheritedalternateURL : String
If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again.
LoaderItemVars
 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).
LoaderCoreVars
 InheritedestimatedBytes : uint
Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined).
LoaderItemVars
  integrateProgress : Boolean = true
By default, the XMLLoader will automatically look for LoaderMax-related nodes like <LoaderMax>, <ImageLoader>, <SWFLoader>, <XMLLoader>, <MP3Loader>, <DataLoader>, and <CSSLoader> inside the XML when it inits.
XMLLoaderVars
 Inheritedname : String
A name that is used to identify the loader instance.
LoaderCoreVars
 InheritednoCache : Boolean
If true, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).
LoaderItemVars
 InheritedonCancel : Function
A handler function for LoaderEvent.CANCEL events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or cancel() was manually called.
LoaderCoreVars
  onChildCancel : Function
A handler function for LoaderEvent.CHILD_CANCEL events which are dispatched each time loading is aborted on any nested LoaderMax-related loaders that were defined in the XML due to either an error or because another loader was prioritized in the queue or because cancel() was manually called on the child loader.
XMLLoaderVars
  onChildComplete : Function
A handler function for LoaderEvent.CHILD_COMPLETE events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML finishes loading successfully.
XMLLoaderVars
  onChildFail : Function
A handler function for LoaderEvent.CHILD_FAIL events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML fails (and its status chances to LoaderStatus.FAILED).
XMLLoaderVars
  onChildOpen : Function
A handler function for LoaderEvent.CHILD_OPEN events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML begins loading.
XMLLoaderVars
  onChildProgress : Function
A handler function for LoaderEvent.CHILD_PROGRESS events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML dispatches a PROGRESS event.
XMLLoaderVars
 InheritedonComplete : Function
A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully.
LoaderCoreVars
 InheritedonError : Function
A handler function for LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR).
LoaderCoreVars
 InheritedonFail : Function
A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED.
LoaderCoreVars
 InheritedonHTTPStatus : Function
A handler function for LoaderEvent.HTTP_STATUS events.
LoaderCoreVars
 InheritedonIOError : Function
A handler function for LoaderEvent.IO_ERROR events which will also call the onError handler, so you can use that as more of a catch-all whereas onIOError is specifically for LoaderEvent.IO_ERROR events.
LoaderCoreVars
 InheritedonOpen : Function
A handler function for LoaderEvent.OPEN events which are dispatched when the loader begins loading.
LoaderCoreVars
 InheritedonProgress : Function
A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes.
LoaderCoreVars
 InheritedrequireWithRoot : DisplayObject
LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
LoaderCoreVars
Public Methods
 MethodDefined by
  
XMLLoaderVars(name:String = "", estimatedBytes:uint = 0, onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)
Constructor
XMLLoaderVars
  
clone():XMLLoaderVars
Clones the object.
XMLLoaderVars
Property detail
integrateProgressproperty
public var integrateProgress:Boolean = true

By default, the XMLLoader will automatically look for LoaderMax-related nodes like <LoaderMax>, <ImageLoader>, <SWFLoader>, <XMLLoader>, <MP3Loader>, <DataLoader>, and <CSSLoader> inside the XML when it inits. If it finds any that have a load="true" attribute, it will begin loading them and integrate their progress into the XMLLoader's overall progress. Its COMPLETE event won't fire until all of these loaders have completed as well. If you prefer NOT to integrate the dynamically-created loader instances into the XMLLoader's overall progress, set integrateProgress to false.

onChildCancelproperty 
public var onChildCancel:Function

A handler function for LoaderEvent.CHILD_CANCEL events which are dispatched each time loading is aborted on any nested LoaderMax-related loaders that were defined in the XML due to either an error or because another loader was prioritized in the queue or because cancel() was manually called on the child loader. Make sure your onChildCancel function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

onChildCompleteproperty 
public var onChildComplete:Function

A handler function for LoaderEvent.CHILD_COMPLETE events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML finishes loading successfully. Make sure your onChildComplete function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

onChildFailproperty 
public var onChildFail:Function

A handler function for LoaderEvent.CHILD_FAIL events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML fails (and its status chances to LoaderStatus.FAILED). Make sure your onChildFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

onChildOpenproperty 
public var onChildOpen:Function

A handler function for LoaderEvent.CHILD_OPEN events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML begins loading. Make sure your onChildOpen function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

onChildProgressproperty 
public var onChildProgress:Function

A handler function for LoaderEvent.CHILD_PROGRESS events which are dispatched each time any nested LoaderMax-related loaders that were defined in the XML dispatches a PROGRESS event. To listen for changes in the XMLLoader's overall progress, use the onProgress special property instead. You can use the LoaderEvent's target.progress to get the child loader's progress value or use its target.bytesLoaded and target.bytesTotal. The LoaderEvent's currentTarget refers to the XMLLoader, so you can check its overall progress with the LoaderEvent's currentTarget.progress. Make sure your onChildProgress function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Constructor detail
XMLLoaderVars()constructor
public function XMLLoaderVars(name:String = "", estimatedBytes:uint = 0, onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)

Constructor

Parameters
name:String (default = "") — 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".
 
estimatedBytes:uint (default = 0) — Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting estimatedBytes is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader is inserted into a LoaderMax instance (for queue management), its auditSize feature can attempt to automatically determine the bytesTotal at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).
 
onComplete:Function (default = null) — 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 (com.greensock.events.LoaderEvent).
 
onProgress:Function (default = null) — 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 (com.greensock.events.LoaderEvent). You can use the LoaderEvent's target.progress to get the loader's progress value or use its target.bytesLoaded and target.bytesTotal.
 
onFail:Function (default = null) — A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED. Make sure your onFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
 
noCache:Boolean (default = false) — If true, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).
 
alternateURL:String (default = "") — If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again. Think of it as a fallback or backup url. It is perfectly acceptable to use the same alternateURL for multiple loaders (maybe a default image for various ImageLoaders for example).
 
requireWithRoot:DisplayObject (default = null) — LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this loader as part of its parent SWFLoader's progress, you must set the requireWithRoot property to your swf's root. For example, vars.requireWithRoot = this.root;.
Method detail
clone()method
public function clone():XMLLoaderVars

Clones the object.

Returns
XMLLoaderVars