| パッケージ | 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 | プロパティ |
attachments: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 <attachment> entries in the package definition, wrapped in Attachment objects.
実装
public function get attachments():IList関連する API エレメント
controllers | プロパティ |
controllers: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 <controllers> entries in the package definition, wrapped in Controller objects.
実装
public function get controllers():IList関連する API エレメント
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, 10:34 AM Z