PackageDefinition

套件	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

A PackageDefinition is an object that wraps the package definition XML file (package.xml). This class is responsible for loading the XML from the package definition file.

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.

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		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

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		PackageDefinition() Creates a PackageDefinition object.	PackageDefinition
		expiredResources():IList Return a list that contains all of the expired <resource> entries in the package definition, wrapped in Resource objects.	PackageDefinition
		getAttachmentsByControllerId(id:String):IList A convenience method that searches through the attachments and returns a list containing only the attachments that match the given id.	PackageDefinition
		getControllerById(id:String, ns:String = null):Controller A convenience method that searches through the contollers and returns the controller with the matching id and XML namespace.	PackageDefinition
		getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList A convenience method that searches through the resources and returns a list containing only the resources that match the given id.	PackageDefinition
		getVersion():Number The PackageDefinition version.	PackageDefinition
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		packageObjectReady(packageObject:IPackageObject):void Broadcast an IPackageObjectReadyEvent.	PackageDefinition
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():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

屬性詳細資訊

建構函式詳細資料

方法詳細資訊

常數詳細資訊

法律聲明 | 線上隱私權政策

PackageDefinition - AS3 Asset Placement

套件x

語言元素

附錄

套件 com.adobe.icomm.assetplacement.model

attachments

controllers

packageDefinitionFile

packageLoaded

resources

expiredResources

getAttachmentsByControllerId

getControllerById

getResourcesByControllerId

getVersion

packageObjectReady

PACKAGE_VERSION_1_0

PACKAGE_VERSION_2_0

	`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`) — The `XML namespace` of a controller. If null the first controller with the matching the id will be returned.

	`id:String` — The `id` of a component, such as a PromoImage.

	`includeExpired:Boolean` (default = `false`) — Boolean whether to include expired resources in the returned list.