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

Package | com.greensock.loading.data
Class | public class CSSLoaderVars

Can be used instead of a generic Object to define the `vars` parameter of a CSSLoader's constructor.
There are 2 primary benefits of using a CSSLoaderVars instance to define your CSSLoader variables:

1. In most code editors, code hinting will be activated which helps remind you which special properties are available in CSSLoader
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).

The down side, of course, is that the code is more verbose and the CSSLoaderVars class adds slightly more kb to your swf. USAGE:
Note that each method returns the CSSLoaderVars instance, so you can reduce the lines of code by method chaining (see example below).
Without CSSLoaderVars:
`new CSSLoader("styles.css", {name:"css", estimatedBytes:1500, onComplete:completeHandler, onProgress:progressHandler})`
With CSSLoaderVars
`new CSSLoader("styles.css", new CSSLoaderVars().name("css").estimatedBytes(1500).onComplete(completeHandler).onProgress(progressHandler))`
NOTES:

- To get the generic vars object that CSSLoaderVars builds internally, simply access its "vars" property. In fact, if you want maximum backwards compatibility, you can tack ".vars" onto the end of your chain like this:
  `new CSSLoader("styles.css", new CSSLoaderVars().name("css").estimatedBytes(1500).vars);`
- Using CSSLoaderVars 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 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

| Property | Defined by
--- | --- | ---
|  | vars : Object [read-only] The generic Object populated by all of the method calls in the CSSLoaderVars instance. | CSSLoaderVars

Public Methods

| Method | Defined by
--- | --- | ---
|  | CSSLoaderVars(vars:Object = null) Constructor | CSSLoaderVars
|  | allowMalformedURL(value:Boolean):CSSLoaderVars Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. | CSSLoaderVars
|  | alternateURL(value:String):CSSLoaderVars 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. | CSSLoaderVars
|  | autoDispose(value:Boolean):CSSLoaderVars When `autoDispose` is `true`, the loader will be disposed immediately after it completes (it calls the `dispose()` method internally after dispatching its `COMPLETE` event). | CSSLoaderVars
|  | estimatedBytes(value:uint):CSSLoaderVars Initially, the loader's `bytesTotal` is set to the `estimatedBytes` value (or `LoaderMax.defaultEstimatedBytes` if one isn't defined). | CSSLoaderVars
|  | name(value:String):CSSLoaderVars A name that is used to identify the loader instance. | CSSLoaderVars
|  | noCache(value:Boolean):CSSLoaderVars If `true`, a "gsCacheBusterID" 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). | CSSLoaderVars
|  | onCancel(value:Function):CSSLoaderVars 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. | CSSLoaderVars
|  | onComplete(value:Function):CSSLoaderVars A handler function for `LoaderEvent.COMPLETE` events which are dispatched when the loader has finished loading successfully. | CSSLoaderVars
|  | onError(value:Function):CSSLoaderVars A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). | CSSLoaderVars
|  | onFail(value:Function):CSSLoaderVars A handler function for `LoaderEvent.FAIL` events which are dispatched whenever the loader fails and its `status` changes to `LoaderStatus.FAILED`. | CSSLoaderVars
|  | onHTTPStatus(value:Function):CSSLoaderVars A handler function for `LoaderEvent.HTTP_STATUS` events. | CSSLoaderVars
|  | onIOError(value:Function):CSSLoaderVars 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. | CSSLoaderVars
|  | onOpen(value:Function):CSSLoaderVars A handler function for `LoaderEvent.OPEN` events which are dispatched when the loader begins loading. | CSSLoaderVars
|  | onProgress(value:Function):CSSLoaderVars A handler function for `LoaderEvent.PROGRESS` events which are dispatched whenever the `bytesLoaded` changes. | CSSLoaderVars
|  | prop(property:String, value:*):CSSLoaderVars Adds a dynamic property to the vars object containing any value you want. | CSSLoaderVars
|  | requireWithRoot(value:DisplayObject):CSSLoaderVars LoaderMax supports subloading, where an object can be factored into a parent's loading progress. | CSSLoaderVars

Property detail

vars | property

`vars:Object` [read-only]

The generic Object populated by all of the method calls in the CSSLoaderVars instance. This is the raw data that gets passed to the loader.

Implementation
`public function get vars():Object`
Constructor detail

CSSLoaderVars | () | constructor

`public function CSSLoaderVars(vars:Object = null)`

Constructor

Parameters

| `vars:Object` (default = `null`)`` — A generic Object containing properties that you'd like to add to this CSSLoaderVars instance.

Method detail

allowMalformedURL | () | method

`public function allowMalformedURL(value:Boolean):CSSLoaderVars`

Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. This avoids a few bugs in Flash, but if you need to keep the entire URL intact (no parsing into URLVariables), set `allowMalformedURL:true`. For example, if your URL has duplicate variables in the query string like `http://www.greensock.com/?c=S&c=SE&c=SW`, it is technically considered a malformed URL and a URLVariables object can't properly contain all the duplicates, so in this case you'd want to set `allowMalformedURL` to `true`.

Parameters

| `value:Boolean`

Returns

| `CSSLoaderVars`

alternateURL | () | method |

`public function alternateURL(value:String):CSSLoaderVars`

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

Parameters

| `value:String`

Returns

| `CSSLoaderVars`

autoDispose | () | method |

`public function autoDispose(value:Boolean):CSSLoaderVars`

When `autoDispose` is `true`, the loader will be disposed immediately after it completes (it calls the `dispose()` method internally after dispatching its `COMPLETE` event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with `LoaderMax.getLoader()` or `LoaderMax.getContent()` - it is essentially destroyed but its content is not unloaded (you must call `unload()` or `dispose(true)` to unload its content). The default `autoDispose` value is `false`.

Parameters

| `value:Boolean`

Returns

| `CSSLoaderVars`

estimatedBytes | () | method |

`public function estimatedBytes(value:uint):CSSLoaderVars`

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

Parameters

| `value:uint`

Returns

| `CSSLoaderVars`

name | () | method |

`public function name(value:String):CSSLoaderVars`

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".

Parameters

| `value:String`

Returns

| `CSSLoaderVars`

noCache | () | method |

`public function noCache(value:Boolean):CSSLoaderVars`

If `true`, a "gsCacheBusterID" 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).

Parameters

| `value:Boolean`

Returns

| `CSSLoaderVars`

onCancel | () | method |

`public function onCancel(value:Function):CSSLoaderVars`

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. Make sure your onCancel function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onComplete | () | method |

`public function onComplete(value:Function):CSSLoaderVars`

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

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onError | () | method |

`public function onError(value:Function):CSSLoaderVars`

A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the `onFail` special property. Make sure your onError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onFail | () | method |

`public function onFail(value:Function):CSSLoaderVars`

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

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onHTTPStatus | () | method |

`public function onHTTPStatus(value:Function):CSSLoaderVars`

A handler function for `LoaderEvent.HTTP_STATUS` events. Make sure your onHTTPStatus function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`). You can determine the httpStatus code using the LoaderEvent's `target.httpStatus` (LoaderItems keep track of their `httpStatus` when possible, although certain environments prevent Flash from getting httpStatus information).

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onIOError | () | method |

`public function onIOError(value:Function):CSSLoaderVars`

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. Make sure your onIOError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onOpen | () | method |

`public function onOpen(value:Function):CSSLoaderVars`

A handler function for `LoaderEvent.OPEN` events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

onProgress | () | method |

`public function onProgress(value:Function):CSSLoaderVars`

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

Parameters

| `value:Function`

Returns

| `CSSLoaderVars`

prop | () | method |

`public function prop(property:String, value:*):CSSLoaderVars`

Adds a dynamic property to the vars object containing any value you want. This can be useful in situations where you need to associate certain data with a particular loader. Just make sure that the property name is a valid variable name (starts with a letter or underscore, no special characters, etc.) and that it doesn't use a reserved property name like "name" or "onComplete", etc. For example, to set an "index" property to 5, do: `prop("index", 5);`

Parameters

| `property:String` — Property name
| `value:*` — Value

Returns

| `CSSLoaderVars`

requireWithRoot | () | method |

`public function requireWithRoot(value:DisplayObject):CSSLoaderVars`

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

Parameters

| `value:DisplayObject`

Returns

| `CSSLoaderVars`