/**
* VERSION: 1.23
* DATE: 2011-07-30
* AS3
* UPDATES AND DOCS AT: http://www.greensock.com/loadermax/
**/
package com.greensock.loading.data {
import flash.display.DisplayObject;
import flash.display.DisplayObjectContainer;
import flash.system.LoaderContext;
/**
* Can be used instead of a generic object to define the vars
parameter of an SWFLoader's constructor.
*
* There are 2 primary benefits of using a SWFLoaderVars instance to define your SWFLoader variables:
*
onComplete
where a Function is expected).
* new SWFLoader("child.swf", {name:"swf", estimatedBytes:11500, container:this, width:400, height:300, onComplete:completeHandler, onProgress:progressHandler})
*
* With SWFLoaderVars
* new SWFLoader("photo1.jpg", new SWFLoaderVars().name("swf").estimatedBytes(11500).container(this).width(400).height(300).onComplete(completeHandler).onProgress(progressHandler))
*
* NOTES:
* new SWFLoader("child.swf", new SWFLoaderVars().name("swf").estimatedBytes(11500).vars);
prop("index", 5);
*
* @param property Property name
* @param value Value
*/
public function prop(property:String, value:*):SWFLoaderVars {
return _set(property, value);
}
//---- LOADERCORE PROPERTIES -----------------------------------------------------------------
/** 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
.**/
public function autoDispose(value:Boolean):SWFLoaderVars {
return _set("autoDispose", value);
}
/** 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". **/
public function name(value:String):SWFLoaderVars {
return _set("name", value);
}
/** 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
). **/
public function onCancel(value:Function):SWFLoaderVars {
return _set("onCancel", value);
}
/** 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
). **/
public function onComplete(value:Function):SWFLoaderVars {
return _set("onComplete", value);
}
/** 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
). **/
public function onError(value:Function):SWFLoaderVars {
return _set("onError", value);
}
/** 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
). **/
public function onFail(value:Function):SWFLoaderVars {
return _set("onFail", value);
}
/** 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).**/
public function onHTTPStatus(value:Function):SWFLoaderVars {
return _set("onHTTPStatus", value);
}
/** 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
). **/
public function onIOError(value:Function):SWFLoaderVars {
return _set("onIOError", value);
}
/** 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
).**/
public function onOpen(value:Function):SWFLoaderVars {
return _set("onOpen", value);
}
/** 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
.**/
public function onProgress(value:Function):SWFLoaderVars {
return _set("onProgress", value);
}
/** 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;
. **/
public function requireWithRoot(value:DisplayObject):SWFLoaderVars {
return _set("requireWithRoot", value);
}
//---- LOADERITEM PROPERTIES -------------------------------------------------------------
/** 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 SWFLoaders for example). **/
public function alternateURL(value:String):SWFLoaderVars {
return _set("alternateURL", value);
}
/** 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). **/
public function estimatedBytes(value:uint):SWFLoaderVars {
return _set("estimatedBytes", value);
}
/** 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). **/
public function noCache(value:Boolean):SWFLoaderVars {
return _set("noCache", value);
}
/** 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
. **/
public function allowMalformedURL(value:Boolean):SWFLoaderVars {
return _set("allowMalformedURL", value);
}
//---- DISPLAYOBJECTLOADER PROPERTIES ------------------------------------------------------------
/** Sets the ContentDisplay
's alpha
property. **/
public function alpha(value:Number):SWFLoaderVars {
return _set("alpha", value);
}
/** Controls the alpha of the rectangle that is drawn when a width
and height
are defined. **/
public function bgAlpha(value:Number):SWFLoaderVars {
return _set("bgAlpha", value);
}
/** When a width
and height
are defined, a rectangle will be drawn inside the ContentDisplay
Sprite immediately in order to ease the development process. It is transparent by default, but you may define a bgColor
if you prefer. **/
public function bgColor(value:uint):SWFLoaderVars {
return _set("bgColor", value);
}
/** Sets the ContentDisplay
's blendMode
property. **/
public function blendMode(value:String):SWFLoaderVars {
return _set("blendMode", value);
}
/** 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. **/
public function centerRegistration(value:Boolean):SWFLoaderVars {
return _set("centerRegistration", value);
}
/** A DisplayObjectContainer into which the ContentDisplay
Sprite should be added immediately. **/
public function container(value:DisplayObjectContainer):SWFLoaderVars {
return _set("container", value);
}
/** 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. **/
public function context(value:LoaderContext):SWFLoaderVars {
return _set("context", value);
}
/** 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). This is typically useful when the scaleMode
is "proportionalOutside"
or "none"
so that any parts of the image that exceed the dimensions defined by width
and height
are visually chopped off. Use the hAlign
and vAlign
special properties to control the vertical and horizontal alignment within the cropped area. **/
public function crop(value:Boolean):SWFLoaderVars {
return _set("crop", value);
}
/**
* When a width
and height
is defined, the hAlign
determines how the image is horizontally aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode
constants if you prefer):
* "center"
(the default) - The image will be centered horizontally in the area"left"
- The image will be aligned with the left side of the area"right"
- The image will be aligned with the right side of the areaContentDisplay
's height
property (applied before rotation, scaleX, and scaleY). **/
public function height(value:Number):SWFLoaderVars {
return _set("height", value);
}
/** 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. Make sure your onSecurityError function accepts a single parameter of type LoaderEvent
(com.greensock.events.LoaderEvent
). **/
public function onSecurityError(value:Function):SWFLoaderVars {
return _set("onSecurityError", value);
}
/** Sets the ContentDisplay
's rotation
property. **/
public function rotation(value:Number):SWFLoaderVars {
return _set("rotation", value);
}
/** Sets the ContentDisplay
's rotationX
property. **/
public function rotationX(value:Number):SWFLoaderVars {
return _set("rotationX", value);
}
/** Sets the ContentDisplay
's rotationY
property. **/
public function rotationY(value:Number):SWFLoaderVars {
return _set("rotationY", value);
}
/** Sets the ContentDisplay
's rotationZ
property. **/
public function rotationZ(value:Number):SWFLoaderVars {
return _set("rotationZ", value);
}
/**
* When a 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"
(the default) - The image will fill the width/height exactly. "proportionalInside"
- The image will be scaled proportionally to fit inside the area defined by the width/height"proportionalOutside"
- The image will be scaled proportionally to completely fill the area, allowing portions of it to exceed the bounds defined by the width/height. "widthOnly"
- Only the width of the image will be adjusted to fit."heightOnly"
- Only the height of the image will be adjusted to fit."none"
- No scaling of the image will occur. ContentDisplay
's scaleX
property. **/
public function scaleX(value:Number):SWFLoaderVars {
return _set("scaleX", value);
}
/** Sets the ContentDisplay
's scaleY
property. **/
public function scaleY(value:Number):SWFLoaderVars {
return _set("scaleY", value);
}
/**
* When a width
and height
is defined, the vAlign
determines how the image is vertically aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode
constants if you prefer):
* "center"
(the default) - The image will be centered vertically in the area"top"
- The image will be aligned with the top of the area"bottom"
- The image will be aligned with the bottom of the areaContentDisplay
's visible
property. **/
public function visible(value:Boolean):SWFLoaderVars {
return _set("visible", value);
}
/** Sets the ContentDisplay
's width
property (applied before rotation, scaleX, and scaleY). **/
public function width(value:Number):SWFLoaderVars {
return _set("width", value);
}
/** Sets the ContentDisplay
's x
property (for positioning on the stage). **/
public function x(value:Number):SWFLoaderVars {
return _set("x", value);
}
/** Sets the ContentDisplay
's y
property (for positioning on the stage). **/
public function y(value:Number):SWFLoaderVars {
return _set("y", value);
}
/** Sets the ContentDisplay
's z
property (for positioning on the stage). **/
public function z(value:Number):SWFLoaderVars {
return _set("z", value);
}
//---- SWFLOADER PROPERTIES ------------------------------------------------------------
/** 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. This only calls stop()
on the main timeline but it does not prevent scripted animations. **/
public function autoPlay(value:Boolean):SWFLoaderVars {
return _set("autoPlay", value);
}
/** 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
. **/
public function integrateProgress(value:Boolean):SWFLoaderVars {
return _set("integrateProgress", value);
}
/** 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
). **/
public function onInit(value:Function):SWFLoaderVars {
return _set("onInit", value);
}
/** 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
).**/
public function onChildOpen(value:Function):SWFLoaderVars {
return _set("onChildOpen", value);
}
/** 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
).**/
public function onChildProgress(value:Function):SWFLoaderVars {
return _set("onChildProgress", value);
}
/** 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
). **/
public function onChildComplete(value:Function):SWFLoaderVars {
return _set("onChildComplete", value);
}
/** 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
). **/
public function onChildCancel(value:Function):SWFLoaderVars {
return _set("onChildCancel", value);
}
/** 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
).**/
public function onChildFail(value:Function):SWFLoaderVars {
return _set("onChildFail", value);
}
/** A handler function for LoaderEvent.UNCAUGHT_ERROR
events which are dispatched when the subloaded swf encounters an UncaughtErrorEvent meaning an Error was thrown outside of a try...catch statement. This can be useful when subloading swfs from a 3rd party that may contain errors. However, UNCAUGHT_ERROR events will only be dispatched if the parent swf is published for Flash Player 10.1 or later! See SWFLoader's suppressUncaughtErrors
special property if you'd like to have it automatically suppress these errors. The original UncaughtErrorEvent is stored in the LoaderEvent's data
property. So, for example, if you'd like to call preventDefault()
on that UncaughtErrorEvent, you'd do myLoaderEvent.data.preventDefault()
. **/
public function onUncaughtError(value:Function):SWFLoaderVars {
return _set("onUncaughtError", value);
}
/** If true
, the SWFLoader will suppress the REMOVED_FROM_STAGE
and ADDED_TO_STAGE
events that are normally dispatched when the subloaded swf is reparented into the ContentDisplay (this always happens in Flash when any DisplayObject that's in the display list gets reparented - SWFLoader just circumvents it by default initially to avoid common problems that could arise if the child swf is coded a certain way). For example, if your subloaded swf has this code: addEventListener(Event.REMOVED_FROM_STAGE, disposeEverything)
and you set suppressInitReparentEvents
to false
, disposeEverything()
would get called as soon as the swf inits (assuming the ContentDisplay is in the display list). **/
public function suppressInitReparentEvents(value:Boolean):SWFLoaderVars {
return _set("suppressInitReparentEvents", value);
}
/** To automatically suppress uncaught errors in the subloaded swf (errors that are thrown outside of a try...catch statement), set suppressUncaughtErrors
to true
, but please note that this will ONLY work if the parent swf is published to Flash Player 10.1 or later. Suppressing the UncaughtErrorEvent simply means calling its preventDefault()
and stopImmediatePropagation()
methods as well as preventing it from bubbling up to its parent LoaderMax/SWFLoader anscestors. If you'd rather listen for these events so that you can handle them yourself, listen for the LoaderEvent.UNCAUGHT_ERROR
event. The original UncaughtErrorEvent instance will be stored in the LoaderEvent's data
property. **/
public function suppressUncaughtErrors(value:Boolean):SWFLoaderVars {
return _set("suppressUncaughtErrors", value);
}
//---- GETTERS / SETTERS -----------------------------------------------------------------
/** The generic Object populated by all of the method calls in the SWFLoaderVars instance. This is the raw data that gets passed to the loader. **/
public function get vars():Object {
return _vars;
}
/** @private **/
public function get isGSVars():Boolean {
return true;
}
}
}