| Package | com.adobe.icomm.assetplacement.model |
| Class | public final class PackageDefinitionLoader |
| Inheritance | PackageDefinitionLoader  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The PackageDefinition object loads the package definition file (package.xml) in a
non-blocking operation. The PackageDefinitionLoader uses an eventListener/eventDispatcher mechanism
to get a reference to the PackageDefinition object, in order to ensure:
- That every caller gets access to the same object (to prevent redundant loading of the package.xml file); and
- That the package is fully loaded before a caller makes use of it.
In order to get a reference to the PackageDefinition object, add an event listener for the
PackageDefinitionReadyEvent and make a call to getPackageDefinition(). When
the PackageDefinition object is ready for use, the listener will be called. Add an event listener for the
PackageDefinitionLoadFailed event to get notification that the package definition failed to load.
Note: the PackageDefinitionReadyEvent listener should be removed once the event fires; if it is not removed the event may fire multiple times when other requesters ask for the PackageDefinition object.
Related API Elements
com.adobe.icomm.assetplacement.model.PackageDefinitionReadyEvent
com.adobe.icomm.assetplacement.model.PackageDefinitionLoadFailedEvent
Hide Inherited Public Properties
Show Inherited Public Properties| Method | Defined By | ||
|---|---|---|---|
Calling the constructor will result in a runtime error. | PackageDefinitionLoader | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [static]
Registers an event listener object with an EventDispatcher object so that the listener receives notification
of an event. | PackageDefinitionLoader | ||
 |
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
[static]
Ask for the PackageDefinition object. | PackageDefinitionLoader | ||
[static]
Removes a listener from the EventDispatcher object. | PackageDefinitionLoader | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
PackageDefinitionLoader | () | Constructor |
public function PackageDefinitionLoader()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Calling the constructor will result in a runtime error.
addEventListener | () | method |
public static function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeListener(). Then you can register the listener again with the new priority level.
Keep in mind that after the listener is registered, subsequent calls to addEventListener() with a different type or useCapture value result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase and another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
If you no longer need an event listener, remove it by calling removeEventListener(), or memory problems could result. Event listeners are not automatically removed from memory because the garbage collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference parameter is set to true).
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless registered again for future processing).
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an Event object as
its only parameter and must return nothing, as this example shows:
function(evt:Event):void
The function can have any name. | |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false)Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent. |
readyPackageDefinition | () | method |
public static function readyPackageDefinition(onPackageDefinitionReady:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Ask for the PackageDefinition object. When the object is ready, listeners will receive a PackageDefinitionReadyEvent that contains a reference to the PackageDefinition object.
Parameters
onPackageDefinitionReady:Function (default = null) |
Related API Elements
removeEventListener | () | method |
public static function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false) |
public function init():void
{
PackageDefinitionLoader.addEventListener(PackageDefinitionReadyEvent.PACKAGE_DEFINITION_READY, onPackageDefinitionReady);
PackageDefinitionLoader.addEventListener(PackageDefinitionLoadFailedEvent.PACKAGE_DEFINITION_LOAD_FAILED, onPackageDefinitionLoadFailed);
PackageDefinitionLoader.readyPackageDefinition();
}
public function onPackageDefinitionReady(event:PackageDefinitionReadyEvent):void
{
// Once we get the ready event, we don't want to listen for it anymore
PackageDefinitionLoader.removeEventListener(PackageDefinitionReadyEvent.PACKAGE_DEFINITION_READY, onPackageDefinitionReady);
PackageDefinitionLoader.removeEventListener(PackageDefinitionLoadFailedEvent.PACKAGE_DEFINITION_LOAD_FAILED, onPackageDefinitionLoadFailed);
var packageDef:PackageDefinition = event.packageDefinition;
}
public function onPackageDefinitionLoadFailed(event:PackageDefinitionLoadFailedEvent):void
{
PackageDefinitionLoader.removeEventListener(PackageDefinitionReadyEvent.PACKAGE_DEFINITION_READY, onPackageDefinitionReady);
PackageDefinitionLoader.removeEventListener(PackageDefinitionLoadFailedEvent.PACKAGE_DEFINITION_LOAD_FAILED, onPackageDefinitionLoadFailed);
var error:String = event.error;
}
Thu Dec 6 2018, 01:12 PM -08:00