Package | fl.display |
Class | public class ProLoader |
Inheritance | ProLoader Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
Note ProLoader is not a subclass of flash.display.Loader. To use ProLoader, you are required to change all Loader type references to ProLoader.
ProLoader delivers a consistent loading experience. It is especially helpful with
SWF files that use RSL preloading. For example, SWF files that use TLF text use RSL
preloading by default. In these cases, ProLoaderInfo delays sending the INIT or COMPLETE
events until RSL preloading has completed and real content is available. As a result,
the content
property can then access real content. ProLoader also
helps you avoid other problems, such as:
- Extra
addedToStage
andremovedFromStage
events - Content that is loaded to the wrong parent on frame one (applies to content published to Flash Player 10.2 or higher using Flash Professional CS5.5 or higher).
Warning Certain ProLoader members do not support all runtime versions. Access these members only when your published AIR or Flash Player version supports them. Otherwise, these APIs throw runtime errors. Members with limited runtime support include the following methods and property:
-
unloadAndStop()
-
loadFilePromise()
-
uncaughtErrorEvents
See the reference topic for each API to verify its runtime support.
Learn more
Property | Defined By | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
content : DisplayObject [read-only]
Contains the root display object of the SWF file or image (JPG, PNG, or GIF)
file that was loaded by using the load() or loadBytes() methods. | ProLoader | ||
contentLoaderInfo : ProLoaderInfo [read-only]
Returns a ProLoaderInfo object corresponding to the object being loaded. | ProLoader | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | ||
height : Number
Indicates the height of the display object, in pixels. | DisplayObject | ||
hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | ||
root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | ||
rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | ||
scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
uncaughtErrorEvents : EventDispatcher [read-only]
An object that dispatches an uncaughtError event when an unhandled error
occurs in code in this ProLoader object's SWF file. | ProLoader | ||
useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | ||
visible : Boolean
Whether or not the display object is visible. | DisplayObject | ||
width : Number
Indicates the width of the display object, in pixels. | DisplayObject | ||
x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Creates a ProLoader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files. | ProLoader | ||
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Cancels a load() method operation that is currently in progress for the ProLoader instance. | ProLoader | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | ||
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Loads a SWF, JPEG, progressive JPEG, unanimated GIF, or PNG file into an object that is a child of
this ProLoader object. | ProLoader | ||
Loads from binary data stored in a ByteArray object. | ProLoader | ||
Loads an IFilePromise instance through the promise parameter. | ProLoader | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | ||
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Raises a virtual keyboard. | InteractiveObject | ||
Changes the position of an existing child in the display object container. | DisplayObjectContainer | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Lets the user drag the specified sprite. | Sprite | ||
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | ||
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | ||
Ends the startDrag() method. | Sprite | ||
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Removes a child of this ProLoader object that was loaded by using the load() method. | ProLoader | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
content | property |
content:DisplayObject
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
Contains the root display object of the SWF file or image (JPG, PNG, or GIF)
file that was loaded by using the load()
or loadBytes()
methods.
Implementation
public function get content():DisplayObject
Throws
SecurityError — The loaded SWF file or image file belongs to a security
sandbox to which you do not have access. For a loaded SWF file, you can avoid this situation by having
the file call the Security.allowDomain() method or by having the loading file specify a
loaderContext parameter with its securityDomain property set to
SecurityDomain.currentDomain when you call the load() or
loadBytes() method.
|
contentLoaderInfo | property |
contentLoaderInfo:ProLoaderInfo
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
Returns a ProLoaderInfo object corresponding to the object being loaded. ProLoaderInfo objects are shared between the ProLoader object and the loaded content object. The ProLoaderInfo object supplies loading progress information and statistics about the loaded file.
Events related to the load are dispatched by the ProLoaderInfo object referenced by the
contentLoaderInfo
property of the ProLoader object. The contentLoaderInfo
property is set to a valid ProLoaderInfo object, even before the content is loaded, so that you can add
event listeners to the object prior to the load.
To detect uncaught errors that happen in a loaded SWF, use the
ProLoader.uncaughtErrorEvents
property, not the
ProLoader.contentLoaderInfo.uncaughtErrorEvents
property.
Note The contentLoaderInfo property returns a ProLoaderInfo object. ProLoaderInfo is not a subclass of LoaderInfo and hence does not give you the advantage of an implicit cast to the super-class. Therefore, be sure to change your type declarations from LoaderInfo to ProLoaderInfo.
Implementation
public function get contentLoaderInfo():ProLoaderInfo
uncaughtErrorEvents | property |
uncaughtErrorEvents:EventDispatcher
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 10.1, AIR 2.0 |
An object that dispatches an uncaughtError
event when an unhandled error
occurs in code in this ProLoader 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 object 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.
Accessing this ProLoader property in a player that does not support it results in an error. Returns an EventDispatcher object instead of an UncaughtErrorEvents object to avoid generating errors in unsupporting players.
Implementation
public function get uncaughtErrorEvents():EventDispatcher
Related API Elements
ProLoader | () | Constructor |
public function ProLoader()
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
Creates a ProLoader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files.
Call the load()
method to load the asset as a child of the ProLoader instance.
You can then add the ProLoader object to the display list (for instance, by using the
addChild()
method of a DisplayObjectContainer instance).
The asset appears on the stage as it loads.
You can also use a ProLoader instance "offlist," that is without adding it to a display object container on the display list. In this mode, the Loader instance might be used to load a SWF file that contains additional modules of an application.
To detect when the SWF file is finished loading, you can use the events of the ProLoaderInfo
object associated with the contentLoaderInfo
property of the ProLoader object.
At that point, the code in the module SWF file can be executed to initialize and start the module.
In the offlist mode, a ProLoader instance might also be used to load a SWF file that contains components or
media assets. Again, you can use the ProLoaderInfo object event notifications to detect when the
components are finished loading. At that point, the application can start using the components
and media assets in the library of the SWF file by instantiating the ActionScript 3.0 classes that represent
those components and assets.
To determine the status of a ProLoader object, monitor the following events that the ProLoaderInfo
object associated with the contentLoaderInfo
property of the ProLoader object:
- The
open
event is dispatched when loading begins. - The
ioError
orsecurityError
event is dispatched if the file cannot be loaded or if an error occured during the load process. - The
progress
event fires continuously while the file is being loaded. - The
complete
event is dispatched when a file completes downloading, but before the loaded movie clip's methods and properties are available. If the loaded SWF file uses RSL preloading, this event is dispatched after RSL preloading completes. At this point, real content is available in thecontent
property. - The
init
event is dispatched after the properties and methods of the loaded SWF file are accessible, so you can begin manipulating the loaded SWF file. This event is dispatched before thecomplete
handler. In streaming SWF files, theinit
event can occur significantly earlier than thecomplete
event. For most purposes, use theinit
handler. If the loaded SWF file uses RSL preloading, this event is dispatched after RSL preloading completes. At this point, real content is available in thecontent
property.
Related API Elements
close | () | method |
public function close():void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player Player - 9 |
Cancels a load()
method operation that is currently in progress for the ProLoader instance.
load | () | method |
public function load(request:URLRequest, context:LoaderContext = null):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Player Player - 9 |
Loads a SWF, JPEG, progressive JPEG, unanimated GIF, or PNG file into an object that is a child of
this ProLoader object. If you load an animated GIF file, only the first frame is displayed.
As the ProLoader object can contain only a single child, issuing a subsequent load()
request terminates the previous request, if still pending, and commences a new load.
Note: In AIR 1.5 and Flash Player 10, the maximum size for a loaded image is 8,191 pixels in width or height, and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an loaded image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, the limitation is 2,880 pixels in height and 2,880 pixels in width.
A SWF file or image loaded into a ProLoader object inherits the position, rotation, and scale properties of the parent display objects of the ProLoader object.
Use the unload()
method to remove movies or images loaded with this
method, or to cancel a load operation that is in progress.
You can prevent a SWF file from using this method by setting the allowNetworking
parameter of the the object
and embed
tags in the HTML
page that contains the SWF content.
When you use this method, consider the Flash Player security model, which is described in the ProLoader class description.
In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), the POST operation is subject to the security rules applied to uploads:
- The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
- If the POST operation is cross-domain (the POST target is not on the same server as the SWF file that is sending the POST request), the target server must provide a URL policy file that permits cross-domain access.
Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standard). If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.
For more information related to security, see the Flash Player Developer Center Topic: Security.
Parameters
request:URLRequest — The absolute or relative URL of the SWF, JPEG, GIF, or PNG file to be loaded. A
relative path must be relative to the main SWF file. Absolute URLs must include the
protocol reference, such as http:// or file:///. Filenames cannot include disk drive
specifications.
| |
context:LoaderContext (default = null ) — A LoaderContext object, which has properties that define the following:
If the For complete details, see the description of the properties in the LoaderContext class. |
Events
asyncError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and it is not possible to add the
loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a
flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws
an error.
| |
complete: — Dispatched by the contentLoaderInfo object when the file has
completed loading. The complete event is always dispatched after the init event.
| |
httpStatus: — Dispatched by the contentLoaderInfo object when a network
request is made over HTTP and Flash Player can detect the HTTP status code.
| |
init: — Dispatched by the contentLoaderInfo object when the properties and methods
of the loaded SWF file are accessible. The init event always precedes the complete
event.
| |
ioError: — Dispatched by the contentLoaderInfo object when an input or output
error occurs that causes a load operation to fail.
| |
open: — Dispatched by the contentLoaderInfo object when the loading operation starts.
| |
progress: — Dispatched by the contentLoaderInfo object as data is received
while load operation progresses.
| |
securityError: — Dispatched by the contentLoaderInfo object if a SWF file
in the local-with-filesystem sandbox attempts to load content in the local-with-networking sandbox, or vice versa.
| |
securityError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and the security sandbox
of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
| |
unload: — Dispatched by the contentLoaderInfo object when a loaded object is removed.
|
Throws
IOError — The digest property of the request object is not
null . You should only set the digest property of a URLRequest object
when calling the URLLoader.load() method when loading a SWZ file (an Adobe
platform component).
| |
SecurityError — The value of LoaderContext.securityDomain must be either null
or SecurityDomain.currentDomain . This reflects the fact that you can only
place the loaded media in its natural security sandbox or your own (the latter requires a
policy file).
| |
SecurityError — Local SWF files may not set LoaderContext.securityDomain to anything
other than null . It is not permitted to import non-local media into a local
sandbox, or to place other local media in anything other than its natural sandbox.
| |
SecurityError — You cannot connect to commonly reserved ports.
For a complete list of blocked ports, see "Restricting Networking APIs" in the
ActionScript 3.0 Developer's Guide.
| |
SecurityError — If the applicationDomain or securityDomain
properties of the context parameter are from a disallowed domain.
| |
SecurityError — If a local SWF file is attempting to use the securityDomain property
of the context parameter.
| |
IllegalOperationError — If the requestedContentParent property of the context parameter
is a ProLoader .
| |
IllegalOperationError — If the LoaderContext.parameters parameter is
set to non-null and has some values which are not Strings.
|
Related API Elements
loadBytes | () | method |
public function loadBytes(bytes:ByteArray, context:LoaderContext = null):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | Flash Player 9, AIR 1.0, Flash Player 9 |
Loads from binary data stored in a ByteArray object.
The loadBytes()
method is asynchronous. You must wait for the "init" event before
accessing the properties of a loaded object.
When you use this method, consider the Flash Player security model, which is described in the ProLoader class description.
Parameters
bytes:ByteArray — A ByteArray object. The contents of the ByteArray can be
any of the file formats supported by the ProLoader class: SWF, GIF, JPEG, or PNG.
| |
context:LoaderContext (default = null ) — A LoaderContext object. Only the applicationDomain property
of the LoaderContext object applies; the checkPolicyFile and securityDomain
properties of the LoaderContext object do not apply.
If the For more information related to security, see the Flash Player Developer Center Topic: Security. |
Events
asyncError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and it is not possible to add the
loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a
flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws
an error.
| |
complete: — Dispatched by the contentLoaderInfo object when the operation is
complete. The complete event is always dispatched after the init event.
| |
init: — Dispatched by the contentLoaderInfo object when the properties and methods
of the loaded data are accessible. The init event always precedes the complete
event.
| |
ioError: — Dispatched by the contentLoaderInfo object when the runtime cannot parse
the data in the byte array.
| |
open: — Dispatched by the contentLoaderInfo object when the operation starts.
| |
progress: — Dispatched by the contentLoaderInfo object as data is transfered in memory.
| |
securityError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and the security sandbox
of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
| |
unload: — Dispatched by the contentLoaderInfo object when a loaded object is removed.
|
Throws
ArgumentError — If the length property of the ByteArray object is not
greater than 0.
| |
IllegalOperationError — If the checkPolicyFile or securityDomain
property of the context parameter are non-null.
| |
IllegalOperationError — If the requestedContentParent property of the context parameter
is a ProLoader .
| |
IllegalOperationError — If the LoaderContext.parameters parameter is
set to non-null and has some values which are not Strings.
| |
SecurityError — If the provided applicationDomain property of the
context property is from a disallowed domain.
| |
SecurityError — You cannot connect to commonly reserved ports.
For a complete list of blocked ports, see "Restricting Networking APIs" in the
ActionScript 3.0 Developer's Guide.
|
Related API Elements
loadFilePromise | () | method |
public function loadFilePromise(promise:Object, context:LoaderContext = null):void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 2.5, AIR 2.0, Flash Player 9 |
Loads an IFilePromise instance through the promise
parameter. The type of the promise
parameter uses
the Object superclass instead of IFilePromise to avoid errors in other players.
The loadFilePromise
method takes an IFilePromise
object and
loads the binary data. If the data is a progressive stream, such as a video wait for the "init"
or progress events before accessing the properties of the loaded object. Otherwise, wait for
the complete event to make sure that the data is fully loaded.
When you use this method, consider the Flash Player security model, which is described in the ProLoader class description.
Parameters
promise:Object — An IFilePromise object. The data source of the object can be
any of the file formats supported by the ProLoader class: SWF, GIF, JPEG, or PNG.
| |
context:LoaderContext (default = null ) — A LoaderContext object. Only the applicationDomain property
of the LoaderContext object applies; the checkPolicyFile and securityDomain
properties of the LoaderContext object do not apply.
If the For more information related to security, see the Flash Player Developer Center Topic: Security. |
Events
asyncError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and it is not possible to add the
loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a
flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws
an error.
| |
complete: — Dispatched by the contentLoaderInfo object when the operation is
complete. The complete event is always dispatched after the init event.
| |
init: — Dispatched by the contentLoaderInfo object when the properties and methods
of the loaded data are accessible. The init event always precedes the complete
event.
| |
ioError: — Dispatched by the contentLoaderInfo object when the runtime cannot parse
the data in the data source or if the data source stream is not readable.
| |
open: — Dispatched by the contentLoaderInfo object when the operation starts.
| |
progress: — Dispatched by the contentLoaderInfo object as data is transfered in memory.
| |
securityError: — Dispatched by the contentLoaderInfo object if the
LoaderContext.requestedContentParent property has been specified and the security sandbox
of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
| |
unload: — Dispatched by the contentLoaderInfo object when a loaded object is removed.
Warning Accessing this API when not in an AIR application results in an error. |
Throws
IllegalOperationError — If the requestedContentParent property of the context parameter
is a ProLoader object.
| |
IllegalOperationError — If the LoaderContext.parameters parameter is
set to non-null and has some values which are not Strings.
| |
ArgumentError — If the IFilePromise object passed as parameter is null
|
Related API Elements
unload | () | method |
public function unload():void
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS5.5 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
Removes a child of this ProLoader object that was loaded by using the load()
method.
The property
of the associated ProLoaderInfo object is reset to null
.
The child is not necessarily destroyed because other objects might have references to it; however,
it is no longer a child of the ProLoader object.
As a best practice, before you unload a child SWF file, you should explicitly
close any streams in the child SWF file's objects, such as LocalConnection, NetConnection,
NetStream, and Sound objects. Otherwise, audio in the child SWF file might continue to play, even
though the child SWF file was unloaded. To close streams in the child SWF file, add an event listener
to the child that listens for the unload
event. When the parent calls
ProLoader.unload()
, the unload
event is dispatched to the child.
The following code shows how you might do this:
function closeAllStreams(evt:Event) { myNetStream.close(); mySound.close(); myNetConnection.close(); myLocalConnection.close(); } myMovieClip.loaderInfo.addEventListener(Event.UNLOAD, closeAllStreams);
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00