API Documentation | All Packages | All Classes | Index | Frames | |
Class DataLoaderVars | Properties | Methods | |
Package | com.greensock.loading.data |
Class | public dynamic class DataLoaderVars |
Inheritance | DataLoaderVars LoaderItemVars LoaderCoreVars |
vars
parameter of a DataLoader's constructor. onComplete
where a Function is expected).new DataLoader("getData.php", {name:"myData", estimatedBytes:1500, format:"text", onComplete:completeHandler, onProgress:progressHandler})
,
you could use this utility like:
var vars:DataLoaderVars = new DataLoaderVars();
vars.name = "myData";
vars.estimatedBytes = 1500;
vars.format = "text";
vars.onComplete = completeHandler;
vars.onProgress = progressHandler;
var loader:DataLoader = new DataLoader("getData.php", vars);
Some of the most common properties can be defined directly in the constructor like this:
var loader:DataLoader = new DataLoader("getData.php", new DataLoaderVars("myData", 1500, "text", completeHandler, progressHandler) );
NOTE: Using DataLoaderVars 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. Property | Defined by | ||
---|---|---|---|
alternateURL : 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 | ||
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). | LoaderCoreVars | ||
estimatedBytes : uint Initially, the loader's
bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). | LoaderItemVars | ||
format : String Controls whether the downloaded data is received as text (
"text" ), raw binary data ("binary" ), or URL-encoded variables ("variables" ). | DataLoaderVars | ||
name : String A name that is used to identify the loader instance.
| LoaderCoreVars | ||
noCache : 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 | ||
onCancel : 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 | ||
onComplete : Function A handler function for
LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. | LoaderCoreVars | ||
onError : 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 | ||
onFail : Function A handler function for
LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED . | LoaderCoreVars | ||
onHTTPStatus : Function A handler function for
LoaderEvent.HTTP_STATUS events. | LoaderCoreVars | ||
onIOError : 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 | ||
onOpen : Function A handler function for
LoaderEvent.OPEN events which are dispatched when the loader begins loading. | LoaderCoreVars | ||
onProgress : Function A handler function for
LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. | LoaderCoreVars | ||
requireWithRoot : DisplayObject LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
| LoaderCoreVars |
Method | Defined by | ||
---|---|---|---|
DataLoaderVars(name:String = "", estimatedBytes:uint = 0, format:String = "text", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)
Constructor
| DataLoaderVars | ||
Clones the object.
| DataLoaderVars |
format | property |
public var format:String
Controls whether the downloaded data is received as text ("text"
), raw binary data ("binary"
), or URL-encoded variables ("variables"
).
DataLoaderVars | () | constructor |
public function DataLoaderVars(name:String = "", estimatedBytes:uint = 0, format:String = "text", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)
Constructor
Parametersname: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).
|
|
format:String (default = "text ") — Controls whether the downloaded data is received as text ("text" ), raw binary data ("binary" ), or URL-encoded variables ("variables" ).
|
|
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; .
|
clone | () | method |