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.

Связанные элементы API

com.adobe.icomm.assetplacement.model.PackageDefinitionLoader

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		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

Сведения о свойстве

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

com.adobe.icomm.assetplacement.model.Attachment

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

com.adobe.icomm.assetplacement.model.Controller

packageDefinitionFile

свойство

packageDefinitionFile:String [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Asset Placement Building Block 9.5

Версии среды выполнения:

AIR 1.0, Flash Player 9, Flash Player 10

The file path of the package definition file that underlies this object.

Реализация
public static function get packageDefinitionFile():String

packageLoaded

свойство

packageLoaded:Boolean [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Asset Placement Building Block 9.5

Версии среды выполнения:

AIR 1.0, Flash Player 9, Flash Player 10

Check to see if the package is loaded.

Реализация
public function get packageLoaded():Boolean

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

com.adobe.icomm.assetplacement.model.Resource

Сведения о конструкторе

()

Конструктор

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

com.adobe.icomm.assetplacement.model.PackageDefinitionLoader

Сведения о методе

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

com.adobe.icomm.assetplacement.model.Resource

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

com.adobe.icomm.assetplacement.model.Attachment

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`) — The `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

com.adobe.icomm.assetplacement.model.Controller

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`) — Boolean whether to include expired resources in the returned list.

Возвращает

IList — A list of Resource objects who's controller ID match the given id.

Связанные элементы API

com.adobe.icomm.assetplacement.model.Resource

getVersion

()

метод

public function getVersion():Number

Язык версии:

ActionScript 3.0

Версия продукта:

Asset Placement Building Block 10

Версии среды выполнения:

AIR 1.0, Flash Player 9, Flash Player 10

The PackageDefinition version.

Возвращает

Number — The package definition version.

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

com.adobe.icomm.assetplacement.model.PackageObjectReadyEvent

Сведения о константе

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.

Юридическая информация | Политика конфиденциальности онлайн

PackageDefinition - AS3 Asset Placement

Классы x

attachments

controllers

packageDefinitionFile

packageLoaded

resources

PackageDefinition

expiredResources

getAttachmentsByControllerId

getControllerById

getResourcesByControllerId

getVersion

packageObjectReady

PACKAGE_VERSION_1_0

PACKAGE_VERSION_2_0