| Package | com.greensock.loading.data |
| Class | public dynamic class SWFLoaderVars |
| Inheritance | SWFLoaderVars  DisplayObjectLoaderVars LoaderItemVars LoaderCoreVars |
vars parameter of a SWFLoader's constructor. onComplete where a Function is expected).new SWFLoader("main.swf", {name:"swf", estimatedBytes:11500, container:this, width:200, height:100, onComplete:completeHandler, onProgress:progressHandler}),
you could use this utility like:
var vars:SWFLoaderVars = new SWFLoaderVars();
vars.name = "swf";
vars.estimatedBytes = 11500;
vars.container = this;
vars.width = 200;
vars.height = 100;
vars.onComplete = completeHandler;
vars.onProgress = progressHandler;
var loader:SWFLoader = new SWFLoader("main.swf", vars);
Some of the most common properties can be defined directly in the constructor like this:
var loader:SWFLoader = new SWFLoader("main.swf", new SWFLoaderVars("swf", 11500, this, 200, 100, completeHandler, progressHandler) );
NOTE: Using SWFLoaderVars 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 | ||
|---|---|---|---|
 | alpha : Number = 1 Sets the
ContentDisplay's alpha property. | DisplayObjectLoaderVars | |
| 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 | |
| autoPlay : Boolean If
autoPlay is true (the default), the swf will begin playing immediately when the INIT event fires. | SWFLoaderVars | ||
| bgAlpha : Number = 0 Controls the alpha of the rectangle that is drawn when a
width and height are defined. | DisplayObjectLoaderVars | |
| bgColor : uint = 0 When a
width and height are defined, a rectangle will be drawn inside the ContentDisplay Sprite immediately in order to ease the development process. | DisplayObjectLoaderVars | |
| blendMode : String = "normal" Sets the
ContentDisplay's blendMode property. | DisplayObjectLoaderVars | |
| centerRegistration : Boolean If
true, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center. | DisplayObjectLoaderVars | |
| container : DisplayObjectContainer A DisplayObjectContainer into which the
ContentDisplay Sprite should be added immediately. | DisplayObjectLoaderVars | |
| context : LoaderContext To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a
LoaderContext object. | SWFLoaderVars | ||
| crop : Boolean When a
width and height are defined, setting crop to true will cause the image to be cropped within that area (by applying a scrollRect for maximum performance). | DisplayObjectLoaderVars | |
| estimatedBytes : uint Initially, the loader's
bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). | LoaderItemVars | |
| hAlign : String = "center"
When a
width and height is defined, the hAlign determines how the image is horizontally aligned within that area. | DisplayObjectLoaderVars | |
| height : Number Sets the
ContentDisplay's height property (applied before rotation, scaleX, and scaleY). | DisplayObjectLoaderVars | |
| integrateProgress : Boolean = true By default, a SWFLoader instance will automatically look for LoaderMax loaders in the swf when it initializes.
| SWFLoaderVars | ||
| 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 | |
| onChildCancel : Function A handler function for
LoaderEvent.CHILD_CANCEL events which are dispatched each time loading is aborted on any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) due to either an error or because another loader was prioritized in the queue or because cancel() was manually called on the child loader. | SWFLoaderVars | ||
| onChildComplete : Function A handler function for
LoaderEvent.CHILD_COMPLETE events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) finishes loading successfully. | SWFLoaderVars | ||
| onChildFail : Function A handler function for
LoaderEvent.CHILD_FAIL events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) fails (and its status chances to LoaderStatus.FAILED). | SWFLoaderVars | ||
| onChildOpen : Function A handler function for
LoaderEvent.CHILD_OPEN events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) begins loading. | SWFLoaderVars | ||
| onChildProgress : Function A handler function for
LoaderEvent.CHILD_PROGRESS events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) dispatches a PROGRESS event. | SWFLoaderVars | ||
| 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 | |
| onInit : Function A handler function for
LoaderEvent.INIT events which are called when the swf has streamed enough of its content to render the first frame and determine if there are any required LoaderMax-related loaders recognized. | SWFLoaderVars | ||
| 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 | |
| onSecurityError : Function A handler function for
LoaderEvent.SECURITY_ERROR events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events. | DisplayObjectLoaderVars | |
| requireWithRoot : DisplayObject LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
| LoaderCoreVars | |
| rotation : Number = 0 Sets the
ContentDisplay's rotation property. | DisplayObjectLoaderVars | |
| scaleMode : String
When a
width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area. | DisplayObjectLoaderVars | |
| scaleX : Number = 1 Sets the
ContentDisplay's scaleX property. | DisplayObjectLoaderVars | |
| scaleY : Number = 1 Sets the
ContentDisplay's scaleY property. | DisplayObjectLoaderVars | |
| vAlign : String = "center"
When a
width and height is defined, the vAlign determines how the image is vertically aligned within that area. | DisplayObjectLoaderVars | |
| visible : Boolean = true Sets the
ContentDisplay's visible property. | DisplayObjectLoaderVars | |
| width : Number Sets the
ContentDisplay's width property (applied before rotation, scaleX, and scaleY). | DisplayObjectLoaderVars | |
| x : Number = 0 Sets the
ContentDisplay's x property (for positioning on the stage). | DisplayObjectLoaderVars | |
| y : Number = 0 Sets the
ContentDisplay's y property (for positioning on the stage). | DisplayObjectLoaderVars | |
| Method | Defined by | ||
|---|---|---|---|
|
SWFLoaderVars(name:String = "", estimatedBytes:uint = 0, container:DisplayObjectContainer = null, autoPlay:Boolean = true, width:Number, height:Number, scaleMode:String = "stretch", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)
Constructor
| SWFLoaderVars | ||
|
Clones the object.
| SWFLoaderVars | ||
| autoPlay | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var autoPlay:Boolean If autoPlay is true (the default), the swf will begin playing immediately when the INIT event fires. To prevent this behavior, set autoPlay to false which will also mute the swf until the SWFLoader completes.
| context | property |
public var context:LoaderContext To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a LoaderContext object. By default, the policy file will be checked when running remotely, so make sure the appropriate crossdomain.xml file is in place. See Adobe's LoaderContext documentation for details and precautions.
| integrateProgress | property |
public var integrateProgress:Boolean = true By default, a SWFLoader instance will automatically look for LoaderMax loaders in the swf when it initializes. Every loader found with a requireWithRoot parameter set to that swf's root will be integrated into the SWFLoader's overall progress. The SWFLoader's COMPLETE event won't fire until all such loaders are also complete. If you prefer NOT to integrate the subloading loaders into the SWFLoader's overall progress, set integrateProgress to false.
| onChildCancel | property |
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 (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) 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).
| onChildComplete | property |
public var onChildComplete:Function A handler function for LoaderEvent.CHILD_COMPLETE events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) finishes loading successfully. Make sure your onChildComplete function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildFail | property |
public var onChildFail:Function A handler function for LoaderEvent.CHILD_FAIL events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) fails (and its status chances to LoaderStatus.FAILED). Make sure your onChildFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildOpen | property |
public var onChildOpen:Function A handler function for LoaderEvent.CHILD_OPEN events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) begins loading. Make sure your onChildOpen function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildProgress | property |
public var onChildProgress:Function A handler function for LoaderEvent.CHILD_PROGRESS events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their requireWithRoot set to its root) dispatches a PROGRESS event. To listen for changes in the SWFLoader'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 SWFLoader, 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).
| onInit | property |
public var onInit:Function A handler function for LoaderEvent.INIT events which are called when the swf has streamed enough of its content to render the first frame and determine if there are any required LoaderMax-related loaders recognized. It also adds the swf to the ContentDisplay Sprite at this point. Make sure your onInit function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| SWFLoaderVars | () | constructor |
public function SWFLoaderVars(name:String = "", estimatedBytes:uint = 0, container:DisplayObjectContainer = null, autoPlay:Boolean = true, width:Number, height:Number, scaleMode:String = "stretch", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, noCache:Boolean = false, alternateURL:String = "", requireWithRoot:DisplayObject = null)Constructor
Parametersname:String (default = "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)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).
|
|
container:DisplayObjectContainer (default = null)ContentDisplay Sprite should be added immediately.
|
|
autoPlay:Boolean (default = true)autoPlay is true (the default), the swf will begin playing immediately when the INIT event fires. To prevent this behavior, set autoPlay to false which will also mute the swf until the SWFLoader completes.
|
|
width:Number — Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).
|
|
height:Number — Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).
|
|
scaleMode:String (default = "stretch")width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area. The following values are recognized (you may use the com.greensock.layout.ScaleMode constants if you prefer):"stretch" | "proportionalInside" | "proportionalOutside" | "widthOnly" | "heightOnly" | "none"
|
|
onComplete:Function (default = null)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)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)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)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 = "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 SWFLoaders for example).
|
|
requireWithRoot:DisplayObject (default = null)requireWithRoot property to your swf's root. For example, vars.requireWithRoot = this.root;.
|
| clone | () | method |