import { EventDispatcher } from "../events/EventDispatcher"; import { ApplicationDomain } from "../system/ApplicationDomain"; import { Loader } from "./Loader"; import { DisplayObject } from "./DisplayObject"; import { ByteArray } from "../utils/ByteArray"; /** * Dispatched when a network request is made over HTTP and an HTTP status code can be detected. * @eventType flash.events.HTTPStatusEvent.HTTP_STATUS [Event(name="httpStatus", type="flash.events.HTTPStatusEvent")] * Dispatched by a LoaderInfo object whenever a loaded object is removed by using the unload() * method of the Loader object, or when a second load is performed by the same Loader object and the * original content is removed prior to the load beginning. * @eventType flash.events.Event.UNLOAD [Event(name="unload", type="flash.events.Event")] * Dispatched when data is received as the download operation progresses. * @eventType flash.events.ProgressEvent.PROGRESS [Event(name="progress", type="flash.events.ProgressEvent")] * Dispatched when a load operation starts. * @eventType flash.events.Event.OPEN [Event(name="open", type="flash.events.Event")] * Dispatched when an input or output error occurs that causes a load operation to fail. * @eventType flash.events.IOErrorEvent.IO_ERROR [Event(name="ioError", type="flash.events.IOErrorEvent")] * Dispatched when the properties and methods of a loaded SWF file are * accessible and ready for use. * @eventType flash.events.Event.INIT [Event(name="init", type="flash.events.Event")] * Dispatched when data has loaded successfully. * @eventType flash.events.Event.COMPLETE [Event(name="complete", type="flash.events.Event")] * The LoaderInfo class provides information about a loaded SWF file or a loaded image file * (JPEG, GIF, or PNG). LoaderInfo objects are available for any display object. * The information provided includes load progress, the URLs of the loader and * loaded content, the number of bytes total for the media, and the nominal height and width of the * media. * *

You can access LoaderInfo objects in two ways:

The contentLoaderInfo property of a Loader object provides information about * the content that the Loader object is loading, whereas the loaderInfo property of * a DisplayObject provides information about the root SWF file for that display object.

When you use a Loader object to load a display object (such as a SWF file or a bitmap), the * loaderInfo property of the display object is the same as the contentLoaderInfo * property of the Loader object (DisplayObject.loaderInfo = Loader.contentLoaderInfo). * Because the instance of the main class of the SWF file has * no Loader object, the loaderInfo property is the only way to * access the LoaderInfo for the instance of the main class of the SWF file.

The following diagram shows the different uses of the LoaderInfo object—for the instance of the main class of * the SWF file, for the contentLoaderInfo property of a Loader object, and for the loaderInfo * property of a loaded object:

When a loading operation is not complete, some properties of the contentLoaderInfo * property of a Loader object are not available. You can obtain some properties, such as * bytesLoaded, bytesTotal, url, loaderURL, * and applicationDomain. When the loaderInfo object dispatches the * init event, you can access all properties of the loaderInfo object and * the loaded image or SWF file.

Note: All properties of LoaderInfo objects are read-only.

The EventDispatcher.dispatchEvent() method * * is not applicable to LoaderInfo objects. If you call dispatchEvent() * on a LoaderInfo object, an IllegalOperationError exception is thrown.

* * EXAMPLE: * * The following example uses the LoaderInfoExample class to display an image on * the stage. This is accomplished by performing the following steps: *
  1. A property url is created, which is the location and name of the image.
  2. The class constructor creates a Loader object named loader.
  3. The loader object instantiates an event listener to ensure that the image loads properly.
  4. The constructor creates a new instance of a URLRequest object, request, * with url passed so that the file name and location are known.
  5. The request object is then passed to the load() method of the * loader object, which loads the image onto the display list.

Important: This example requires that you add a file named Image.gif in the same directory * as the compiled SWF file. Use an image that has an area that fits within the dimensions of the main SWF file.

* package { * import flash.display.Loader; * import flash.display.LoaderInfo; * import flash.display.Sprite; * import flash.events.*; * import flash.net.URLRequest; * * public class LoaderInfoExample extends Sprite { * private var url:String = "Image.gif"; * * public function LoaderInfoExample() { * var loader:Loader = new Loader(); * loader.contentLoaderInfo.addEventListener(Event.INIT, initHandler); * loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler); * var request:URLRequest = new URLRequest(url); * loader.load(request); * addChild(loader); * } * * private function initHandler(event:Event):void { * var loader:Loader = Loader(event.target.loader); * var info:LoaderInfo = LoaderInfo(loader.contentLoaderInfo); * trace("initHandler: loaderURL=" + info.loaderURL + " url=" + info.url); * } * * private function ioErrorHandler(event:IOErrorEvent):void { * trace("ioErrorHandler: " + event); * } * } * } * * @langversion 3.0 * @playerversion Flash 9 * @playerversion Lite 4 * @internal Update the places LoaderInfo can be obtained from (playerglobal.as) and double-check loader vs. loadee. */ export declare class LoaderInfo extends EventDispatcher { private _applicationDomain; /** * The ActionScript version of the loaded SWF file. * * The language version is specified by using the enumerations in the * ActionScriptVersion class, such as ActionScriptVersion.ACTIONSCRIPT2 * and ActionScriptVersion.ACTIONSCRIPT3. * * Note: This property always has a value of either ActionScriptVersion.ACTIONSCRIPT2 or * ActionScriptVersion.ACTIONSCRIPT3. ActionScript 1.0 and 2.0 are * both reported as ActionScriptVersion.ACTIONSCRIPT2 (version 2.0). This property * only distinguishes ActionScript 1.0 and 2.0 from ActionScript 3.0. * @throws Error If the file is not downloaded sufficiently to retrieve the requested information. * @throws Error If the file is not a SWF file. */ readonly actionScriptVersion: number; constructor(target?: any); sec: any; getSymbolById(value: any): any; /** * When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded * class are stored in the applicationDomain property. * * All code in a SWF file is defined to exist in an application domain. The current application * domain is where your main application runs. The system domain contains all application domains, * including the current domain and all classes used by Flash Player or Adobe AIR.All application domains, except the system domain, have an associated parent domain. * The parent domain of your main application's applicationDomain is the system domain. * Loaded classes are defined only when their parent doesn't already define them. * You cannot override a loaded class definition with a newer definition.For usage examples of application domains, see the "Client System Environment" chapter * in the ActionScript 3.0 Developer's Guide. * @internal Need better description and example. * @throws SecurityError This security sandbox of the caller is not allowed to access this ApplicationDomain. */ applicationDomain: ApplicationDomain; /** * The bytes associated with a LoaderInfo object. * @throws SecurityError If the object accessing this API is prevented from * accessing the loaded object due to security restrictions. This situation can occur, * for instance, when a Loader object attempts to access the contentLoaderInfo.content * property and it is not granted security permission to access the loaded content. * * For more information related to security, see the Flash Player Developer Center Topic: * Security. */ readonly bytes: ByteArray; /** * The number of bytes that are loaded for the media. When this number equals * the value of bytesTotal, all of the bytes are loaded. */ readonly bytesLoaded: number; /** * The number of compressed bytes in the entire media file. * * Before the first progress event is dispatched by * this LoaderInfo object's corresponding Loader object, bytesTotal is 0. * After the first progress event from the Loader object, bytesTotal * reflects the actual number of bytes to be downloaded. */ readonly bytesTotal: number; /** * Expresses the trust relationship from content (child) to the Loader (parent). * If the child has allowed the parent access, true; otherwise, * false. This property is set to true if the child object * has called the allowDomain() method to grant permission to the parent domain * or if a URL policy is loaded at the child domain that grants permission * to the parent domain. If child and parent are in * the same domain, this property is set to true. * * For more information related to security, see the Flash Player Developer Center Topic: * Security. * @throws Error Thrown if the file is not downloaded sufficiently * to retrieve the requested information. */ readonly childAllowsParent: boolean; /** * A object that can be set by the loaded content's code to expose properties and methods that can be accessed * by code in the Loader object's sandbox. This sandbox bridge lets content from a non-application domain have * controlled access to scripts in the AIR application sandbox, and vice versa. The sandbox bridge serves as a gateway between * the sandboxes, providing explicit interaction between application and non-application security sandboxes. * @throws SecurityError Only content in the loaded content's sandbox can set this property. */ childSandboxBridge: any; /** * The loaded object associated with this LoaderInfo object. * @throws SecurityError If the object accessing this API is prevented from * accessing the loaded object due to security restrictions. This situation can occur, * for instance, when a Loader object attempts to access the contentLoaderInfo.content * property and it is not granted security permission to access the loaded content. * * For more information related to security, see the Flash Player Developer Center Topic: * Security. */ content: DisplayObject; /** * The MIME type of the loaded file. The value is null if not enough of the file has loaded * in order to determine the type. The following list gives the possible values: * * "application/x-shockwave-flash" * "image/jpeg" * "image/gif" * "image/png" */ readonly contentType: string; /** * The nominal frame rate, in frames per second, of the loaded SWF file. This * number is often an integer, but need not be. * * This value may differ from the actual frame rate in use. * Flash Player or Adobe AIR only uses a single frame rate for all loaded SWF files at * any one time, and this frame rate is determined by the nominal * frame rate of the main SWF file. Also, the main frame rate may not be able to be achieved, depending on hardware, sound synchronization, * and other factors. * @throws Error If the file is not downloaded sufficiently to retrieve the requested information. * @throws Error If the file is not a SWF file. */ readonly frameRate: number; /** * The nominal height of the loaded file. This value might differ from the actual * height at which the content is displayed, since the loaded content or its parent * display objects might be scaled. * @throws Error If the file is not downloaded sufficiently to retrieve the requested information. */ readonly height: number; /** * Indicates if the LoaderInfo.url property has been * truncated. When the isURLInaccessible value is true the * LoaderInfo.url value is only the domain of the final URL from which the content loaded. * For example, the property is truncated if the content is loaded from http://www.adobe.com/assets/hello.swf, * and the LoaderInfo.url property has the value http://www.adobe.com. The isURLInaccessible * value is true only when all of the following are also true: * * An HTTP redirect occurred while loading the content.The SWF file calling Loader.load() is from a different domain than * the content's final URL.The SWF file calling Loader.load() does not have permission to access * the content. Permission is granted to access the content the same way permission is granted for * BitmapData.draw(): * call Security.allowDomain() to access a SWF file * (or for non-SWF file content, establish a policy file and use the LoaderContext.checkPolicyFile * property).Note: The isURLInaccessible property was added for Flash Player 10.1 and AIR 2.0. * However, this property is made available to SWF files of all versions when the * Flash runtime supports it. So, using some authoring tools in "strict mode" causes a compilation error. To work around the error * use the indirect syntax myLoaderInfo["isURLInaccessible"], or disable strict mode. If you are using Flash Professional CS5 * or Flex SDK 4.1, you can use and compile this API for runtimes released before Flash Player 10.1 and AIR 2.For application content in AIR, the value of this property is always false. */ readonly isURLInaccessible: boolean; /** * The Loader object associated with this LoaderInfo object. If this LoaderInfo object * is the loaderInfo property of the instance of the main class of the SWF file, no * Loader object is associated. * @throws SecurityError If the object accessing this API is prevented from * accessing the Loader object because of security restrictions. This can occur, * for instance, when a loaded SWF file attempts to access its loaderInfo.loader * property and it is not granted security permission to access the loading SWF file. * * For more information related to security, see the Flash Player Developer Center Topic: * Security. */ readonly loader: Loader; /** * The URL of the SWF file that initiated the loading of the media * described by this LoaderInfo object. For the instance of the main class of the SWF file, this * URL is the same as the SWF file's own URL. */ readonly loaderURL: string; /** * An object that contains name-value pairs that represent the parameters provided * to the loaded SWF file. * * You can use a for-in loop to extract all the names and values * from the parameters object.The two sources of parameters are: the query string in the * URL of the main SWF file, and the value of the FlashVars HTML parameter (this affects * only the main SWF file).The parameters property replaces the ActionScript 1.0 and 2.0 technique of * providing SWF file parameters as properties of the main timeline.The value of the parameters property is null for Loader objects * that contain SWF files that use ActionScript 1.0 or 2.0. It is only * non-null for Loader objects that contain SWF files that use ActionScript 3.0. */ readonly parameters: any; /** * Expresses the trust relationship from Loader (parent) to the content (child). * If the parent has allowed the child access, true; otherwise, * false. This property is set to true if the parent object * called the allowDomain() method to grant permission to the child domain * or if a URL policy file is loaded at the parent domain granting permission * to the child domain. If child and parent are in * the same domain, this property is set to true. * * For more information related to security, see the Flash Player Developer Center Topic: * Security. * @throws Error Thrown if the file is not downloaded sufficiently * to retrieve the requested information. */ readonly parentAllowsChild: boolean; /** * A object that can be set by code in the Loader object's sandbox to expose properties and methods that can be accessed * by the loaded content's code. This sandbox bridge lets content from a non-application domain have controlled * access to scripts in the AIR application sandbox, and vice versa. The sandbox bridge serves as a gateway between * the sandboxes, providing explicit interaction between application and non-application security sandboxes. * @throws SecurityError Only content in the Loader object's sandbox can set this property. */ parentSandboxBridge: any; /** * Expresses the domain relationship between the loader and the content: true if they have * the same origin domain; false otherwise. * @throws Error Thrown if the file is not downloaded sufficiently * to retrieve the requested information. */ readonly sameDomain: boolean; /** * An EventDispatcher instance that can be used to exchange events across security boundaries. * Even when the Loader object and the loaded content originate from security domains that do not trust * one another, both can access sharedEvents and send and receive events via this object. */ readonly sharedEvents: EventDispatcher; /** * The file format version of the loaded SWF file. * * The file format is specified using the enumerations in the * SWFVersion class, such as SWFVersion.FLASH7 and SWFVersion.FLASH9. * @throws Error If the file is not downloaded sufficiently to retrieve the requested information. * @throws Error If the file is not a SWF file. */ readonly swfVersion: number; /** * An object that dispatches an uncaughtError event when an unhandled error * occurs in code in this LoaderInfo object's SWF file. An uncaught error happens when * an error is thrown outside of any try..catch blocks or when an ErrorEvent * object is dispatched with no registered listeners. * * This property is created when the SWF associated with this LoaderInfo has finished * loading. Until then the uncaughtErrorEvents property is null. * In an ActionScript-only project, you can access this property during or after the execution * of the constructor function of the main class of the SWF file. For a Flex project, * the uncaughtErrorEvents property is available after the * applicationComplete event is dispatched. */ readonly uncaughtErrorEvents: any; /** * The URL of the media being loaded. * * Before the first progress event is dispatched by this LoaderInfo * object's corresponding Loader object, the value of the url property * might reflect only the initial URL specified in the call to the load() * method of the Loader object. After the first progress event, the * url property reflects the media's final URL, after any redirects and relative * URLs are resolved.In some cases, the value of the url property is truncated; see the * isURLInaccessible property for details. */ readonly url: string; /** * The nominal width of the loaded content. This value might differ from the actual * width at which the content is displayed, since the loaded content or its parent * display objects might be scaled. * @throws Error If the file is not downloaded sufficiently to retrieve the requested information. */ readonly width: number; /** * Returns the LoaderInfo object associated with a SWF file defined as an object. * @param object The object for which you want to get an associated LoaderInfo object. * @return The associated LoaderInfo object. Returns null when called * in non-debugger builds (or when debugging is not enabled) or if the referenced object * does not have an associated LoaderInfo object (such as some objects used by the AIR runtime). * @throws SecurityError The caller is not running in the local trusted sandbox. */ static getLoaderInfoByDefinition(object: any): LoaderInfo; }