| Package | com.adobe.icomm.assetplacement.model |
| Class | public class PackageDefinition |
| Inheritance | PackageDefinition  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 package definition is divided into two broad sections: <controllers> and <assets>. The <controllers> section contains entries for each AssetPlacement component used in the statement: each PromoImage, PromoImageSlideShow, AttachmentLoader, etc. that is added to the statement will have a <controller> entry automatically added to the package definition file by the Interactive Document Plugin. The <controller> entries are meant to be used later in the statement development cycle, to help choose appropriate advertising content to place in each component.
The <assets> section is used at runtime. Each AssetPlacement component will attempt to load
assets at runtime. A component looks up the <resource> or <attachment> entry with the matching
controller attribute to the components' id attribute and if a match is found
attempts to load the source specified.
It is possible to access the various assets of the package definition by calling the
appropriate methods; assets are divided into two types: attachments and resources. Attachments are
assets that are part of the PDF Navigator and must be accessed through Navigator APIs. Resources
are content that can be loaded directly such as images and SWFs. Generally, an asset is recovered
through its controller id. The controller id is the key that connects a Flex component (such
as a PromoImage) to a resource in the package definition. The component's id
property is the lookup key. Note that many assets may be returned for one ID lookup.
This class is a singleton. Calls to the constructor will result in an exception being thrown. In order to use this class, use the PackageDefinitionLoader class.
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
| attachments : IList [read-only]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| controllers : IList [read-only]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
| packageDefinitionFile : String [static] [read-only]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
| packageLoaded : Boolean [read-only]
Check to see if the package is loaded. | PackageDefinition | ||
| resources : IList [read-only]
A list that contains all of the <resource> (non expired) entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a PackageDefinition object. | PackageDefinition | ||
Return a list that contains all of the expired <resource> entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
A convenience method that searches through the attachments and returns a list
containing only the attachments that match the given id. | PackageDefinition | ||
A convenience method that searches through the contollers and returns the
controller with the matching id and XML namespace. | PackageDefinition | ||
A convenience method that searches through the resources and returns a list
containing only the resources that match the given id. | PackageDefinition | ||
The PackageDefinition version. | PackageDefinition | ||
|
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 | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
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 | |
| Constant | Defined By | ||
|---|---|---|---|
| PACKAGE_VERSION_1_0 : Number = 1.0 [static] The package version 1.0. | PackageDefinition | ||
| PACKAGE_VERSION_2_0 : Number = 2.0 [static] The package version 2.0. | PackageDefinition | ||
attachments | property |
attachments:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A list that contains all of <attachment> entries in the package definition, wrapped in Attachment objects.
Implementation
public function get attachments():IListRelated API Elements
controllers | property |
controllers:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A list that contains all of <controllers> entries in the package definition, wrapped in Controller objects.
Implementation
public function get controllers():IListRelated API Elements
packageDefinitionFile | property |
packageDefinitionFile:String [read-only] | 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 file path of the package definition file that underlies this object.
Implementation
public static function get packageDefinitionFile():StringpackageLoaded | property |
resources | property |
resources:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A list that contains all of the <resource> (non expired) entries in the package definition, wrapped in Resource objects.
Implementation
public function get resources():IListRelated API Elements
PackageDefinition | () | Constructor |
public function PackageDefinition()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a PackageDefinition object. The PackageDefinition is meant to be a singleton object - there is only one package definition that wraps the XML package definition file. Callers should not invoke the constructor, which will throw an error. Rather, use the PackageDefinitionLoader class.
Related API Elements
expiredResources | () | method |
public function expiredResources():IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Return a list that contains all of the expired <resource> entries in the package definition, wrapped in Resource objects.
ReturnsIList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
Related API Elements
getAttachmentsByControllerId | () | method |
public function getAttachmentsByControllerId(id:String):IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the attachments and returns a list
containing only the attachments that match the given id.
The id is usually the id property of a component such
as a PromoImage. The key it is looking up corresponds to the controller
attribute on the <attachment>'s parent <attachments> node.
Parameters
id:String — The id of a component, such as a PromoImage.
|
IList — A list of Attachment objects who's controller ID match the given id.
|
Related API Elements
getControllerById | () | method |
public function getControllerById(id:String, ns:String = null):Controller| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the contollers and returns the
controller with the matching id and XML namespace.
Parameters
id:String — The id of a controller. This id should match an MXML id in the project as
well as a controller id in the <assets> section of the package definition.
| |
ns:String (default = null)XML namespace of a controller. If null the first controller with the matching the id will be returned.
|
Controller — The Controller object that matches this id and XML namespace or null if there is no matching controller.
|
Related API Elements
getResourcesByControllerId | () | method |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A convenience method that searches through the resources and returns a list
containing only the resources that match the given id. The caller indicates
whether to include expired resources via the includeExpired parameter.
The id is usually the id property of a component such
as a PromoImage. The key it is looking up corresponds to the controller
attribute on the <resource>'s parent <resources> node.
Parameters
id:String — The id of a component, such as a PromoImage.
| |
includeExpired:Boolean (default = false) |
IList — A list of Resource objects who's controller ID match the given id.
|
Related API Elements
getVersion | () | method |
packageObjectReady | () | method |
public function packageObjectReady(packageObject:IPackageObject):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 |
Broadcast an IPackageObjectReadyEvent. When an IPackageObject is ready to be used, it asks the package definition to brodcast the PackageObjectReadyEvent. This allows the hosting application to be notified anytime a new statement object is created.
Parameters
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
Related API Elements
PACKAGE_VERSION_1_0 | Constant |
public static const PACKAGE_VERSION_1_0:Number = 1.0| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 10 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 1.0.
PACKAGE_VERSION_2_0 | Constant |
public static const PACKAGE_VERSION_2_0:Number = 2.0| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Placement Building Block 10 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Thu Dec 4 2014, 05:50 PM -08:00