httpStatus value changes. **/
[Event(name="httpStatus", type="com.greensock.events.LoaderEvent")]
/** Dispatched when the loader experiences a SECURITY_ERROR while loading or auditing its size. **/
[Event(name="securityError", type="com.greensock.events.LoaderEvent")]
/**
* Loads a swf file and automatically searches for active loaders in that swf that have
* the requireWithRoot vars property set to that swf's root. If it finds any,
* it will factor those loaders' progress into its own progress and not dispatch its
* COMPLETE event until the nested loaders have finished.
*
* The SWFLoader's content refers to a ContentDisplay (a Sprite) that
* is created immediately so that you can position/scale/rotate it or add ROLL_OVER/ROLL_OUT/CLICK listeners
* before (or while) the swf loads. Use the SWFLoader's content property to get the ContentDisplay
* Sprite, or use the rawContent property to get the actual root of the loaded swf file itself.
* If a container is defined in the vars object, the ContentDisplay will
* immediately be added to that container).
If you define a width and height, it will draw a rectangle
* in the ContentDisplay so that interactive events fire appropriately (rollovers, etc.) and width/height/bounds
* get reported accurately. This rectangle is invisible by default, but you can control its color and alpha
* with the bgColor and bgAlpha properties. When the swf loads, it will be
* added to the ContentDisplay at index 0 with addChildAt() and scaled to fit the width/height according to
* the scaleMode. These are all optional features - you do not need to define a
* width or height in which case the swf will load at its native size.
* See the list below for all the special properties that can be passed through the vars
* parameter but don't let the list overwhelm you - these are all optional and they are intended to make
* your job as a developer much easier.
By default, the SWFLoader will attempt to load the swf in a way that allows full script * access (same SecurityDomain and child ApplicationDomain). However, if a security error is thrown because * the swf is being loaded from another domain and the appropriate crossdomain.xml file isn't in place * to grant access, the SWFLoader will automatically adjust the default LoaderContext so that it falls * back to the more restricted mode which will have the following effect:
*LoaderEvent.SCRIPT_ACCESS_DENIED event will be dispatched and the scriptAccessDenied property of the SWFLoader will be set to true. You can check this value before performing any restricted operations on the content like BitmapData.draw().Loader instance will be added to the ContentDisplay Sprite instead of the swf's root.getClass() and getSWFChild() methods will always return null.draw() will not be able to be performed on the swf.If the loaded swf is an AVM1Movie (built in AS1 or AS2), scriptAccessDenied will be true
* and a Loader instance will be added to the content Sprite instead of the swf's root.
To maximize the likelihood of your swf loading without any security problems, consider taking the following steps:
*AllowScriptAccess to "always"flash.system.Security.allowDomain("~~");A note about garbage collection: A lot of effort has gone into making SWFLoader solve common garbage collection
* problems related to loading and unloading swfs, but since it is impossible for SWFLoader to know all the code that will run in
* the child swf, it cannot automatically remove event listeners, stop NetStreams, sounds, etc., all of which could interfere
* with garbage collection. Therefore it is considered a best practice to [whenever possible] build each subloaded swf so that
* it has some sort of dispose() method that runs cleanup code (removes event listeners, stops sounds, closes NetStreams, etc.).
* When the swf is loaded, you can recursively inspect the chain of parents and if a ContentDisplay object is found (it will
* have a "loader" property), you can add an "unload" event listener so that your dispose() method gets called accordingly.
* For example, in the child swf you could use code like this:
OPTIONAL VARS PROPERTIES
*The following special properties can be passed into the SWFLoader constructor via its vars
* parameter which can be either a generic object or an SWFLoaderVars object:
LoaderMax.getLoader() or LoaderMax.getContent() methods. This name is also applied to the Sprite that is created to hold the swf (The SWFLoader's content refers to this Sprite). Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".content Sprite should be added immediately.ContentDisplay's width property (applied before rotation, scaleX, and scaleY).ContentDisplay's height property (applied before rotation, scaleX, and scaleY).true, the registration point will be placed in the center of the ContentDisplay Sprite which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.width and height are defined, the scaleMode controls how the loaded swf 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 swf will fill the width/height exactly."proportionalInside" - The swf will be scaled proportionally to fit inside the area defined by the width/height"proportionalOutside" - The swf 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 swf will be adjusted to fit."heightOnly" - Only the height of the swf will be adjusted to fit."none" - No scaling of the swf will occur.width and height are defined, the hAlign determines how the swf 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 swf will be centered horizontally in the area"left" - The swf will be aligned with the left side of the area"right" - The swf will be aligned with the right side of the areawidth and height are defined, the vAlign determines how the swf 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 swf will be centered vertically in the area"top" - The swf will be aligned with the top of the area"bottom" - The swf will be aligned with the bottom of the areawidth and height are defined, setting crop to true will cause the swf to be cropped within that area (by applying a scrollRect for maximum performance) based on its native size (not the bounding box of the swf's current contents). This is typically useful when the scaleMode is "proportionalOutside" or "none" or when the swf contains objects that are positioned off-stage. Any parts of the swf 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.ContentDisplay's x property (for positioning on the stage).ContentDisplay's y property (for positioning on the stage).ContentDisplay's scaleX property.ContentDisplay's scaleY property.ContentDisplay's rotation property.ContentDisplay's alpha property.ContentDisplay's visible property.ContentDisplay's blendMode property.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.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 bgAlpha if you prefer.width and height are defined.LoaderContext object. The default context is null when running locally and new LoaderContext(true, new ApplicationDomain(ApplicationDomain.currentDomain), SecurityDomain.currentDomain) when running remotely in order to avoid common security sandbox errors (see Adobe's LoaderContext documentation for details and precautions). Please make sure that if you load swfs from another domain that you have a crossdomain.xml file installed on that remote server that grants your swf access rights (see Adobe's docs for crossdomain.xml details). Again, if you want to impose security restrictions on the loaded swf, please define your own LoaderContext.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).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.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.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).noCache is 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 getLoader() or getContent() by url and when you're running locally)bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). Then, when the swf initializes and has been analyzed enough to determine the size of any nested loaders that were found inside the swf with their requireWithRoot set to that swf's root, it will adjust the bytesTotal accordingly. Setting estimatedBytes is optional, but it provides a way to avoid situations where the progress and bytesTotal values jump around as SWFLoader recognizes nested loaders in the swf and audits their size. The estimatedBytes value should include all nested loaders as well, so if your swf file itself is 2000 bytes and it has 3 nested ImageLoaders, each loading a 2000-byte image, your SWFLoader's estimatedBytes should be 8000. The more accurate the value, the more accurate the loaders' overall progress will be.requireWithRoot property to your swf's root. For example, var loader:SWFLoader = new SWFLoader("subload.swf", {name:"subloadSWF", requireWithRoot:this.root});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.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.
*
* ----EVENT HANDLER SHORTCUTS----
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.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).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).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).LoaderMax.SCRIPT_ACCESS_DENIED events which occur when the swf is loaded from another domain and no crossdomain.xml is in place to grant full script access for things like BitmapData manipulation or integration of LoaderMax data inside the swf, etc. You can also check the scriptAccessDenied property after the swf has loaded. Make sure your function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).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().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).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).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).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).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).Note: Using a SWFLoaderVars 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: com.greensock.loading.display.ContentDisplay (a Sprite).
* When the swf has finished loading, the rawContent will be added to the ContentDisplay
* Sprite at index 0 using addChildAt(). rawContent refers to the loaded swf's root
* unless script access is denied in which case it will be a flash.display.Loader (to avoid security errors).
Copyright 2010-2014, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for Club GreenSock members, the software agreement that was issued with the membership.
* * @see com.greensock.loading.data.SWFLoaderVars * * @author Jack Doyle, jack@greensock.com */ public class SWFLoader extends DisplayObjectLoader { /** @private **/ private static var _classActivated:Boolean = _activateClass("SWFLoader", SWFLoader, "swf"); /** @private last pass-through uncaught error event. primarily for uncaughtError events - when a subloaded swf also has another swf that's subloaded by SWFLoader and that grandchild dispatches an uncaught error, we don't want to allow duplicates to travel up because both SWFLoaders (this and the child's) would be listening for uncaught errors through the _loader and sub-SWFLoader's _loader. **/ protected var _lastPTUncaughtError:Event; /** @private **/ protected var _queue:LoaderMax; /** @private When the INIT event is dispatched, we'll check to see if there's a runtime shared library like for TLF and we must do some backflips to accommodate it - _hasRSL will be toggled to true if we find one. **/ protected var _hasRSL:Boolean; /** @private **/ protected var _rslAddedCount:uint; /** @private In certain browsers, there's a bug in the Flash Player that incorrectly reports the Loader's bytesLoaded as never reaching bytesTotal even AFTER the Loader completes (only when gzip is enabled on the server). This helps us get around that bug. **/ protected var _loaderCompleted:Boolean; /** @private in cases where we must allow a canceled loader to continue loading until it inits (to avoid garbage collection issues), if the url is changed during the time we're in stealthMode, we must remember to load() as soon as the old/bad swf inits! This is the flag we use for that. **/ protected var _loadOnExitStealth:Boolean; /** @private if the Loader fails we must record that so that when _dump() is called, we know that the Loader isn't active anymore and we can safely dump it (as opposed to allowing it to continue loading until it inits which we normally must do in order to avoid garbage collection issues in Flash) **/ protected var _loaderFailed:Boolean; /** * Constructor * * @param urlOrRequest The url (String) or URLRequest from which the loader should get its content
* @param vars An object containing optional configuration details. For example: new SWFLoader("swf/main.swf", {name:"main", container:this, x:100, y:50, alpha:0, autoPlay:false, 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 an SWFLoaderVars object:
LoaderMax.getLoader() or LoaderMax.getContent() methods. This name is also applied to the Sprite that is created to hold the swf (The SWFLoader's content refers to this Sprite). Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".content Sprite should be added immediately.ContentDisplay's width property (applied before rotation, scaleX, and scaleY).ContentDisplay's height property (applied before rotation, scaleX, and scaleY).true, the registration point will be placed in the center of the ContentDisplay Sprite which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.width and height are defined, the scaleMode controls how the loaded swf 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 swf will fill the width/height exactly."proportionalInside" - The swf will be scaled proportionally to fit inside the area defined by the width/height"proportionalOutside" - The swf 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 swf will be adjusted to fit."heightOnly" - Only the height of the swf will be adjusted to fit."none" - No scaling of the swf will occur.width and height are defined, the hAlign determines how the swf 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 swf will be centered horizontally in the area"left" - The swf will be aligned with the left side of the area"right" - The swf will be aligned with the right side of the areawidth and height are defined, the vAlign determines how the swf 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 swf will be centered vertically in the area"top" - The swf will be aligned with the top of the area"bottom" - The swf will be aligned with the bottom of the areawidth and height are defined, setting crop to true will cause the swf to be cropped within that area (by applying a scrollRect for maximum performance) based on its native size (not the bounding box of the swf's current contents). This is typically useful when the scaleMode is "proportionalOutside" or "none" or when the swf contains objects that are positioned off-stage. Any parts of the swf 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.ContentDisplay's x property (for positioning on the stage).ContentDisplay's y property (for positioning on the stage).ContentDisplay's scaleX property.ContentDisplay's scaleY property.ContentDisplay's rotation property.ContentDisplay's alpha property.ContentDisplay's visible property.ContentDisplay's blendMode property.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.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 bgAlpha if you prefer.width and height are defined.LoaderContext object. The default context is null when running locally and new LoaderContext(true, new ApplicationDomain(ApplicationDomain.currentDomain), SecurityDomain.currentDomain) when running remotely in order to avoid common security sandbox errors (see Adobe's LoaderContext documentation for details and precautions). Please make sure that if you load swfs from another domain that you have a crossdomain.xml file installed on that remote server that grants your swf access rights (see Adobe's docs for crossdomain.xml details). Again, if you want to impose security restrictions on the loaded swf, please define your own LoaderContext.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).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.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.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).noCache is 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 getLoader() or getContent() by url and when you're running locally)bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). Then, when the swf initializes and has been analyzed enough to determine the size of any nested loaders that were found inside the swf with their requireWithRoot set to that swf's root, it will adjust the bytesTotal accordingly. Setting estimatedBytes is optional, but it provides a way to avoid situations where the progress and bytesTotal values jump around as SWFLoader recognizes nested loaders in the swf and audits their size. The estimatedBytes value should include all nested loaders as well, so if your swf file itself is 2000 bytes and it has 3 nested ImageLoaders, each loading a 2000-byte image, your SWFLoader's estimatedBytes should be 8000. The more accurate the value, the more accurate the loaders' overall progress will be.requireWithRoot property to your swf's root. For example, var loader:SWFLoader = new SWFLoader("subload.swf", {name:"subloadSWF", requireWithRoot:this.root});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.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.
*
* ----EVENT HANDLER SHORTCUTS----
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.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).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).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).LoaderMax.SCRIPT_ACCESS_DENIED events which occur when the swf is loaded from another domain and no crossdomain.xml is in place to grant full script access for things like BitmapData manipulation or integration of LoaderMax data inside the swf, etc. You can also check the scriptAccessDenied property after the swf has loaded. Make sure your function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).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().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).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).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).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).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).className
*/
public function getClass(className:String):Class {
if (_content == null || _scriptAccessDenied) {
return null;
}
if (_content.loaderInfo.applicationDomain.hasDefinition(className)) {
return _content.loaderInfo.applicationDomain.getDefinition(className);
} else if (_queue != null) {
var result:Object;
var loaders:Array = _queue.getChildren(true, true);
var i:int = loaders.length;
while (--i > -1) {
if (loaders[i] is SWFLoader) {
result = (loaders[i] as SWFLoader).getClass(className);
if (result != null) {
return result as Class;
}
}
}
}
return null;
}
/**
* Finds a DisplayObject that's on the root of the loaded SWF by name. For example,
* you could put a MovieClip with an instance name of "phoneAnimation_mc" on the stage (along with
* any other objects of course) and then when you load that swf you could use
* loader.getSWFChild("phoneAnimation_mc") to get that MovieClip. It would be
* similar to doing (loader.rawContent as DisplayObjectContainer).getChildByName("phoneAnimation_mc")
* but in a more concise way that doesn't require checking to see if the rawContent is null. getSWFChild()
* will return null if the content hasn't loaded yet or if scriptAccessDenied is true.
*
* @param name The name of the child DisplayObject that is located at the root of the swf.
* @return The DisplayObject with the specified name. Returns null if the content hasn't loaded yet or if scriptAccessDenied is true.
*/
public function getSWFChild(name:String):DisplayObject {
return (!_scriptAccessDenied && _content is DisplayObjectContainer) ? DisplayObjectContainer(_content).getChildByName(name) : null;
}
/**
* @private
* Finds a particular loader inside any active LoaderMax instances that were discovered in the subloaded swf
* which had their requireWithRoot set to the swf's root. This is only useful in situations
* where the swf contains other loaders that are required.
*
* @param nameOrURL The name or url associated with the loader that should be found.
* @return The loader associated with the name or url. Returns null if none were found.
*/
public function getLoader(nameOrURL:String):* {
return (_queue != null) ? _queue.getLoader(nameOrURL) : null;
}
/**
* @private
* Finds a particular loader's content from inside any active LoaderMax instances that were discovered in the
* subloaded swf which had their requireWithRoot set to the swf's root. This is only useful
* in situations where the swf contains other loaders that are required.
*
* @param nameOrURL The name or url associated with the loader whose content should be found.
* @return The content associated with the name or url. Returns null if none was found.
*/
public function getContent(nameOrURL:String):* {
if (nameOrURL == this.name || nameOrURL == _url) {
return this.content;
}
var loader:LoaderCore = this.getLoader(nameOrURL);
return (loader != null) ? loader.content : null;
}
/**
* Returns and array of all LoaderMax-related loaders (if any) that were found inside the swf and
* had their requireWithRoot special vars property set to the swf's root. For example,
* if the following code was run on the first frame of the swf, it would be identified as a child
* of this SWFLoader:
*
* var loader:ImageLoader = new ImageLoader("1.jpg", {requireWithRoot:this.root});
Even if loaders are created later (not on frame 1), as long as their requireWithRoot
* points to this swf's root, the loader(s) will be considered a child of this SWFLoader and will be
* returned in the array that getChildren() creates. Beware, however, that by default
* child loaders are integrated into the SWFLoader's progress, so if the swf finishes
* loading and then a while later a loader is created inside that swf that has its requireWithRoot
* set to the swf's root, at that point the SWFLoader's progress would no longer be 1 (it would
* be less) but the SWFLoader's status remains unchanged.
No child loader can be found until the SWFLoader's INIT event is dispatched, meaning the first * frame of the swf has loaded and instantiated.
* * @param includeNested Iftrue, loaders that are nested inside child LoaderMax, XMLLoader, or SWFLoader instances will be included in the returned array as well. The default is false.
* @param omitLoaderMaxes If true, no LoaderMax instances will be returned in the array; only LoaderItems like ImageLoaders, XMLLoaders, SWFLoaders, MP3Loaders, etc. The default is false.
* @return An array of loaders.
*/
public function getChildren(includeNested:Boolean=false, omitLoaderMaxes:Boolean=false):Array {
return (_queue != null) ? _queue.getChildren(includeNested, omitLoaderMaxes) : [];
}
//---- EVENT HANDLERS ------------------------------------------------------------------------------------
/** @private **/
override protected function _initHandler(event:Event):void {
//if the SWFLoader was cancelled before _initHandler() was called, Flash will refuse to properly unload it, so we allow it to continue but check the status here and _dump() if necessary.
if (_stealthMode) {
_initted = true;
var awaitingLoad:Boolean = _loadOnExitStealth;
_dump(((_status == LoaderStatus.DISPOSED) ? 3 : 1), _status, true);
if (awaitingLoad) {
_load();
}
return;
}
//swfs with TLF use their own funky preloader system that causes problems, so we need to work around them here...
_hasRSL = false;
try {
var tempContent:DisplayObject = _loader.content;
var className:String = getQualifiedClassName(tempContent);
if (className.substr(-13) == "__Preloader__") {
var rslPreloader:Object = tempContent["__rslPreloader"];
if (rslPreloader != null) {
className = getQualifiedClassName(rslPreloader);
if (className == "fl.rsl::RSLPreloader") {
_hasRSL = true;
_rslAddedCount = 0;
tempContent.addEventListener(Event.ADDED, _rslAddedHandler);
}
}
}
} catch (error:Error) {
}
if (!_hasRSL) {
_init();
}
}
/** @private **/
protected function _init():void {
_determineScriptAccess();
if (!_scriptAccessDenied) {
if (!_hasRSL) {
_content = _loader.content;
}
if (_content != null) {
if (this.vars.autoPlay == false && _content is MovieClip) {
var st:SoundTransform = _content.soundTransform;
st.volume = 0; //just make sure you can't hear any sounds as it's loading in the background.
_content.soundTransform = st;
_content.stop();
}
_checkRequiredLoaders();
}
if (_loader.parent == _sprite) {
if (_sprite.stage != null && this.vars.suppressInitReparentEvents == true) {
_sprite.addEventListener(Event.ADDED_TO_STAGE, _captureFirstEvent, true, 1000, true);
_loader.addEventListener(Event.REMOVED_FROM_STAGE, _captureFirstEvent, true, 1000, true);
}
_sprite.removeChild(_loader); //we only added it temporarily so that if the child swf references "stage" somewhere, it could avoid errors (as long as this SWFLoader's ContentDisplay is on the stage, like if a "container" is defined in vars)
}
} else {
_content = _loader;
_loader.visible = true;
}
super._initHandler(null);
}
/** @private **/
protected function _captureFirstEvent(event:Event):void {
event.stopImmediatePropagation();
event.currentTarget.removeEventListener(event.type, _captureFirstEvent);
}
/** @private Works around bug - see http://kb2.adobe.com/cps/838/cpsid_83812.html **/
protected function _rslAddedHandler(event:Event):void {
// check to ensure this was actually something added to the _loader.content
if (event.target is DisplayObject && event.currentTarget is DisplayObjectContainer && event.target.parent == event.currentTarget) {
_rslAddedCount++;
}
// the first thing added will be the loader animation swf - ignore that
if (_rslAddedCount > 1) {
event.currentTarget.removeEventListener(Event.ADDED, _rslAddedHandler);
if (_status == LoaderStatus.LOADING) {
_content = event.target;
_init();
_calculateProgress();
dispatchEvent(new LoaderEvent(LoaderEvent.PROGRESS, this));
_completeHandler(null);
}
}
}
/** @private **/
override protected function _passThroughEvent(event:Event):void {
if (!(event.type == "uncaughtError" && _suppressUncaughtError(event)) && event.target != _queue) {
super._passThroughEvent(event);
}
}
/** @private **/
override protected function _progressHandler(event:Event):void {
if (_status == LoaderStatus.LOADING) {
if (_queue == null && _initted) {
_checkRequiredLoaders();
}
if (_dispatchProgress) {
var bl:uint = _cachedBytesLoaded;
var bt:uint = _cachedBytesTotal;
_calculateProgress();
if (_cachedBytesLoaded != _cachedBytesTotal && (bl != _cachedBytesLoaded || bt != _cachedBytesTotal)) {
dispatchEvent(new LoaderEvent(LoaderEvent.PROGRESS, this));
}
} else {
_cacheIsDirty = true;
}
}
}
/** @private **/
override protected function _completeHandler(event:Event=null):void {
_loaderCompleted = true;
_checkRequiredLoaders();
_calculateProgress();
if (this.progress == 1) {
if (!_scriptAccessDenied && this.vars.autoPlay == false && _content is MovieClip) {
var st:SoundTransform = _content.soundTransform;
st.volume = 1;
_content.soundTransform = st;
}
_changeQueueListeners(false);
super._determineScriptAccess(); //now do the BitmapData.draw() test.
super._completeHandler(event);
}
}
/** @private **/
override protected function _errorHandler(event:Event):void {
if (!_suppressUncaughtError(event)) {
super._errorHandler(event);
}
}
/** @private **/
protected function _suppressUncaughtError(event:Event):Boolean {
if (event is LoaderEvent && LoaderEvent(event).data is Event) {
event = LoaderEvent(event).data as Event;
}
if (event.type == "uncaughtError") {
if (_lastPTUncaughtError == (_lastPTUncaughtError = event)) {
return true;
} else if (this.vars.suppressUncaughtErrors == true) {
event.preventDefault();
event.stopImmediatePropagation();
return true;
}
}
return false;
}
/** @private **/
override protected function _failHandler(event:Event, dispatchError:Boolean=true):void {
if ((event.type == "ioError" || event.type == "securityError") && event.target == _loader.contentLoaderInfo) {
_loaderFailed = true;
if (_loadOnExitStealth) { //could happen if the url is set to another value between the time the SWFLoader starts loading and when it fails.
_dump(1, _status, true);
_load();
return;
}
}
if (event.target == _queue) {
//this is a unique situation where we don't want the failure to unload the content because only one of the nested loaders failed but the swf may be perfectly good and usable. Also, we want to retain the _queue so that getChildren() works. Therefore we don't call super._failHandler();
_status = LoaderStatus.FAILED;
_time = getTimer() - _time;
dispatchEvent(new LoaderEvent(LoaderEvent.CANCEL, this));
dispatchEvent(new LoaderEvent(LoaderEvent.FAIL, this, this.toString() + " > " + (event as Object).text));
return;
}
super._failHandler(event, dispatchError);
}
//---- GETTERS / SETTERS ---------------------------------------------------------------
/** @private **/
override public function set url(value:String):void {
if (_url != value) {
if (_status == LoaderStatus.LOADING && !_initted && !_loaderFailed) {
_loadOnExitStealth = true;
}
super.url = value; //will dump() too
}
}
}
}