| 包 | com.adobe.icomm.assetplacement.model |
| 类 | public class PackageDefinition |
| 继承 | PackageDefinition  Object |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
相关 API 元素
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
| attachments : IList [只读]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
 | constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| controllers : IList [只读]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
| packageDefinitionFile : String [静态] [只读]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
| packageLoaded : Boolean [只读]
Check to see if the package is loaded. | PackageDefinition | ||
| resources : IList [只读]
A list that contains all of the <resource> (non expired) entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
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 | ||
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
| 常量 | 由以下参数定义 | ||
|---|---|---|---|
| PACKAGE_VERSION_1_0 : Number = 1.0 [静态] The package version 1.0. | PackageDefinition | ||
| PACKAGE_VERSION_2_0 : Number = 2.0 [静态] The package version 2.0. | PackageDefinition | ||
attachments | 属性 |
controllers | 属性 |
packageDefinitionFile | 属性 |
packageLoaded | 属性 |
resources | 属性 |
resources:IList [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
实现
public function get resources():IList相关 API 元素
PackageDefinition | () | 构造函数 |
public function PackageDefinition()| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
相关 API 元素
expiredResources | () | 方法 |
public function expiredResources():IList| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
返回IList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
相关 API 元素
getAttachmentsByControllerId | () | 方法 |
public function getAttachmentsByControllerId(id:String):IList| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
getControllerById | () | 方法 |
public function getControllerById(id:String, ns:String = null):Controller| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
getResourcesByControllerId | () | 方法 |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
getVersion | () | 方法 |
packageObjectReady | () | 方法 |
public function packageObjectReady(packageObject:IPackageObject):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 9.5 |
| 运行时版本: | 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.
参数
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
相关 API 元素
PACKAGE_VERSION_1_0 | 常量 |
public static const PACKAGE_VERSION_1_0:Number = 1.0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 10 |
| 运行时版本: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 1.0.
PACKAGE_VERSION_2_0 | 常量 |
public static const PACKAGE_VERSION_2_0:Number = 2.0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Placement Building Block 10 |
| 运行时版本: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Tue Jun 12 2018, 11:04 AM Z