PackageDefinition

Pacote	com.adobe.icomm.assetplacement.model
Classe	public class PackageDefinition
Herança	PackageDefinition Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Asset Placement Building Block 9.5

Versões de runtime:

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.

Elementos da API relacionados

com.adobe.icomm.assetplacement.model.PackageDefinitionLoader

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		attachments : IList [somente leitura] A list that contains all of <attachment> entries in the package definition, wrapped in Attachment objects.	PackageDefinition
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		controllers : IList [somente leitura] A list that contains all of <controllers> entries in the package definition, wrapped in Controller objects.	PackageDefinition
		packageDefinitionFile : String [estático] [somente leitura] The file path of the package definition file that underlies this object.	PackageDefinition
		packageLoaded : Boolean [somente leitura] Check to see if the package is loaded.	PackageDefinition
		resources : IList [somente leitura] A list that contains all of the <resource> (non expired) entries in the package definition, wrapped in Resource objects.	PackageDefinition

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		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 Indica se um objeto tem uma propriedade especificada definida.	Object
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		packageObjectReady(packageObject:IPackageObject):void Broadcast an IPackageObjectReadyEvent.	PackageDefinition
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object

Constantes públicas

	Constante		Definido por
		PACKAGE_VERSION_1_0 : Number = 1.0 [estático] The package version 1.0.	PackageDefinition
		PACKAGE_VERSION_2_0 : Number = 2.0 [estático] The package version 2.0.	PackageDefinition

Detalhes da propriedade

Detalhes do construtor

Detalhes do método

Detalhes da constante

Aspectos jurídicos | Política de privacidade on-line

PackageDefinition - AS3 Asset Placement

Pacotesx

Elementos de linguagem

Apêndices

Pacote 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.