Package | fl.display |
Class | public class ProLoaderInfo |
Inheritance | ProLoaderInfo EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Some members of this class, including childSandboxBridge
and parentSandboxBridge
,
are not supported in all versions of Flash Player and AIR. Call these properties only
when your published AIR or Flash Player version supports them. Calling these properties in other contexts results in runtime errors.
Related API Elements
Property | Defined By | ||
---|---|---|---|
actionScriptVersion : uint [read-only]
The ActionScript version of the loaded SWF file. | ProLoaderInfo | ||
applicationDomain : ApplicationDomain [read-only]
When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded
class are stored in the applicationDomain property. | ProLoaderInfo | ||
bytes : ByteArray [read-only]
The bytes associated with a ProLoaderInfo object. | ProLoaderInfo | ||
bytesLoaded : uint [read-only]
The number of bytes that are loaded for the media. | ProLoaderInfo | ||
bytesTotal : uint [read-only]
Before the first progress event is dispatched by this object's corresponding ProLoader object,
bytesTotal is 0. | ProLoaderInfo | ||
childAllowsParent : Boolean [read-only]
Expresses the trust relationship from content (child) to the ProLoader (parent). | ProLoaderInfo | ||
childSandboxBridge : Object
An object that can be set by the loaded content's code to expose properties and methods that can be accessed
by code in the ProLoader object's sandbox. | ProLoaderInfo | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
content : DisplayObject [read-only]
The loaded object associated with this ProLoaderInfo object. | ProLoaderInfo | ||
contentType : String [read-only]
The MIME type of the loaded file. | ProLoaderInfo | ||
frameRate : Number [read-only]
The nominal frame rate, in frames per second, of the loaded SWF file. | ProLoaderInfo | ||
height : int [read-only]
The nominal height of the loaded file. | ProLoaderInfo | ||
isURLInaccessible : Boolean [read-only]
Indicates if the ProLoaderInfo.url property has been
truncated. | ProLoaderInfo | ||
loader : ProLoader [read-only]
The ProLoader object associated with this ProLoaderInfo object. | ProLoaderInfo | ||
loaderURL : String [read-only]
The URL of the SWF file that initiated the loading of the media
described by this ProLoaderInfo object. | ProLoaderInfo | ||
parameters : Object [read-only]
An object that contains name-value pairs that represent the parameters provided
to the loaded SWF file. | ProLoaderInfo | ||
parentAllowsChild : Boolean [read-only]
Expresses the trust relationship from ProLoader (parent) to the content (child). | ProLoaderInfo | ||
parentSandboxBridge : Object
A object that can be set by code in the ProLoader object's sandbox to expose properties and methods that can be accessed
by the loaded content's code. | ProLoaderInfo | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
sameDomain : Boolean [read-only]
Expresses the domain relationship between the loader and the content: true if they have
the same origin domain; false otherwise. | ProLoaderInfo | ||
sharedEvents : EventDispatcher [read-only]
Because of timing issues when loading content that does RSL preloading, it is recommended to wait
until the init event is received to add event listeners to the sharedEvents object, or to add them
again when the init event is received. | ProLoaderInfo | ||
swfVersion : uint [read-only]
The file format version of the loaded SWF file. | ProLoaderInfo | ||
url : String [read-only]
The URL of the media being loaded. | ProLoaderInfo | ||
width : int [read-only]
The nominal width of the loaded content. | ProLoaderInfo |
actionScriptVersion | property |
actionScriptVersion:uint
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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.
Implementation
public function get actionScriptVersion():uint
Related API Elements
applicationDomain | property |
applicationDomain:ApplicationDomain
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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.
Implementation
public function get applicationDomain():ApplicationDomain
Related API Elements
bytes | property |
bytesLoaded | property |
bytesLoaded:uint
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
The number of bytes that are loaded for the media. When this number equals
the value of bytesTotal
, all of the bytes are loaded.
Implementation
public function get bytesLoaded():uint
Related API Elements
bytesTotal | property |
bytesTotal:uint
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Before the first progress
event is dispatched by this object's corresponding ProLoader object,
bytesTotal
is 0. After the first progress event from the ProLoader object, bytesTotal
reflects the actual number of bytes to be downloaded.
Implementation
public function get bytesTotal():uint
Related API Elements
childAllowsParent | property |
childAllowsParent:Boolean
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Expresses the trust relationship from content (child) to the ProLoader (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.
Implementation
public function get childAllowsParent():Boolean
Related API Elements
childSandboxBridge | property |
childSandboxBridge:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0 |
An object that can be set by the loaded content's code to expose properties and methods that can be accessed by code in the ProLoader 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.
Implementation
public function get childSandboxBridge():Object
public function set childSandboxBridge(value:Object):void
Throws
SecurityError — Only content in the loaded content's sandbox can set this property.
|
Related API Elements
content | property |
content:DisplayObject
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
The loaded object associated with this ProLoaderInfo object.
Implementation
public function get content():DisplayObject
Related API Elements
contentType | property |
contentType:String
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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"
Implementation
public function get contentType():String
Related API Elements
frameRate | property |
frameRate:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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.
Implementation
public function get frameRate():Number
Related API Elements
height | property |
height:int
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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.
Implementation
public function get height():int
Related API Elements
isURLInaccessible | property |
isURLInaccessible:Boolean
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 10.1, AIR 2 |
Indicates if the ProLoaderInfo.url
property has been
truncated. When the isURLInaccessible
value is true
the
ProLoaderInfo.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 ProLoaderInfo.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
ProLoader.load()
is from a different domain than the content's final URL. - The SWF file calling
ProLoader.load()
does not have permission to access the content. Permission is granted to access the content the same way permission is granted forBitmapData.draw()
: callSecurity.allowDomain()
to access a SWF file (or for non-SWF file content, establish a policy file and use theLoaderContext.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
.
Implementation
public function get isURLInaccessible():Boolean
Related API Elements
loader | property |
loader:ProLoader
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
The ProLoader object associated with this ProLoaderInfo object. If this ProLoaderInfo object is the loaderInfo property of the instance of the main class of the SWF file, no ProLoader object is associated.
Implementation
public function get loader():ProLoader
Related API Elements
loaderURL | property |
loaderURL:String
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
The URL of the SWF file that initiated the loading of the media described by this ProLoaderInfo object. For the instance of the main class of the SWF file, this URL is the same as the SWF file's own URL.
Implementation
public function get loaderURL():String
Related API Elements
parameters | property |
parameters:Object
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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 ProLoader objects
that contain SWF files that use ActionScript 1.0 or 2.0. It is only
non-null for ProLoader objects that contain SWF files that use ActionScript 3.0.
Implementation
public function get parameters():Object
Related API Elements
parentAllowsChild | property |
parentAllowsChild:Boolean
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Expresses the trust relationship from ProLoader (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.
Implementation
public function get parentAllowsChild():Boolean
Throws
Error — Thrown if the file is not downloaded sufficiently
to retrieve the requested information.
|
Related API Elements
parentSandboxBridge | property |
parentSandboxBridge:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0 |
A object that can be set by code in the ProLoader 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.
Implementation
public function get parentSandboxBridge():Object
public function set parentSandboxBridge(value:Object):void
Throws
SecurityError — Only content in the ProLoader object's sandbox can set this property.
|
Related API Elements
sameDomain | property |
sameDomain:Boolean
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Expresses the domain relationship between the loader and the content: true
if they have
the same origin domain; false
otherwise.
Implementation
public function get sameDomain():Boolean
Related API Elements
sharedEvents | property |
sharedEvents:EventDispatcher
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
Because of timing issues when loading content that does RSL preloading, it is recommended to wait until the init event is received to add event listeners to the sharedEvents object, or to add them again when the init event is received.
Implementation
public function get sharedEvents():EventDispatcher
Related API Elements
swfVersion | property |
swfVersion:uint
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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
.
Implementation
public function get swfVersion():uint
Related API Elements
url | property |
url:String
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
The URL of the media being loaded.
Before the first progress
event is dispatched by this ProLoaderInfo
object's corresponding ProLoader object, the value of the url
property
might reflect only the initial URL specified in the call to the load()
method of the ProLoader 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.
Implementation
public function get url():String
width | property |
width:int
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Lite 4 |
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.
Implementation
public function get width():int
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00