Package | com.greensock.loading |
Class | public class CSSLoader |
Inheritance | CSSLoader DataLoader LoaderItem LoaderCore flash.events.EventDispatcher |
vars
parameter which can be either a generic object or a CSSLoaderVars
object: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".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).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)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).requireWithRoot
property to your swf's root
. For example, var loader:CSSLoader = new CSSLoader("styles.css", {name:"styles", requireWithRoot:this.root});
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
.
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
).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
.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
).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
).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
).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
).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
).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).CSSLoaderVars
instance
instead of a generic object to define your vars
is a bit more verbose but provides
code hinting and improved debugging because it enforces strict data typing. Use whichever one you prefer.content
data type: flash.text.StyleSheet
import com.greensock.loading.*; import com.greensock.events.LoaderEvent; import import flash.text.StyleSheet; //create a CSSLoader var loader:CSSLoader = new CSSLoader("css/styles.css", {name:"myCSS", requireWithRoot:this.root, estimatedBytes:900}); //begin loading loader.load(); //Or you could put the CSSLoader into a LoaderMax. Create one first... var queue:LoaderMax = new LoaderMax({name:"mainQueue", onProgress:progressHandler, onComplete:completeHandler, onError:errorHandler}); //append the CSSLoader and several other loaders queue.append( loader ); queue.append( new SWFLoader("swf/main.swf", {name:"mainSWF", estimatedBytes:4800}) ); queue.append( new ImageLoader("img/photo1.jpg", {name:"photo1", estimatedBytes:3500}) ); //start loading queue.load(); function progressHandler(event:LoaderEvent):void { trace("progress: " + event.target.progress); } function completeHandler(event:LoaderEvent):void { myTextField.styleSheet = LoaderMax.getContent("myCSS"); trace("load complete."); } function errorHandler(event:LoaderEvent):void { trace("error occured with " + event.target + ": " + event.text); }
See also
Method | Defined by | ||
---|---|---|---|
CSSLoader(urlOrRequest:*, vars:Object = null)
Constructor
| CSSLoader | ||
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 |
Event | Summary | Defined by | ||
---|---|---|---|---|
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 | |||
Dispatched when the loader completes. | LoaderCore | |||
Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR. | LoaderCore | |||
Dispatched when the loader fails. | LoaderCore | |||
Dispatched when the loader's httpStatus value changes. | CSSLoader | |||
Dispatched when the loader's httpStatus value changes. | DataLoader | |||
Dispatched when the loader experiences an IO_ERROR while loading or auditing its size. | LoaderItem | |||
Dispatched when the loader starts loading. | LoaderCore | |||
Dispatched each time the bytesLoaded value changes while loading (indicating progress). | LoaderCore | |||
Dispatched when the loader experiences a SECURITY_ERROR while loading or auditing its size. | DataLoader |
CSSLoader | () | constructor |
public function CSSLoader(urlOrRequest:*, vars:Object = null)
Constructor
ParametersurlOrRequest:* — The url (String ) or URLRequest from which the loader should get its content.
|
|
vars:Object (default = null ) — An object containing optional configuration details. For example: new CSSLoader("css/styles.css", {name:"myCSS", onComplete:completeHandler, onProgress:progressHandler}) .The following special properties can be passed into the constructor via the vars parameter
which can be either a generic object or a CSSLoaderVars object:
|
See also
httpStatus | event |
com.greensock.events.LoaderEvent
Dispatched when the loader's httpStatus
value changes.