| 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 |
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
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étodo | Definido por | ||
|---|---|---|---|
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 | ||
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
| 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 | ||
attachments | propriedade |
attachments:IList [somente leitura] | 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 list that contains all of <attachment> entries in the package definition, wrapped in Attachment objects.
Implementação
public function get attachments():IListElementos da API relacionados
controllers | propriedade |
controllers:IList [somente leitura] | 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 list that contains all of <controllers> entries in the package definition, wrapped in Controller objects.
Implementação
public function get controllers():IListElementos da API relacionados
packageDefinitionFile | propriedade |
packageDefinitionFile:String [somente leitura] | 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 |
The file path of the package definition file that underlies this object.
Implementação
public static function get packageDefinitionFile():StringpackageLoaded | propriedade |
resources | propriedade |
resources:IList [somente leitura] | 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 list that contains all of the <resource> (non expired) entries in the package definition, wrapped in Resource objects.
Implementação
public function get resources():IListElementos da API relacionados
PackageDefinition | () | Construtor |
public function PackageDefinition()| 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 |
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.
Elementos da API relacionados
expiredResources | () | método |
public function expiredResources():IList| 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 |
Return a list that contains all of the expired <resource> entries in the package definition, wrapped in Resource objects.
RetornaIList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
Elementos da API relacionados
getAttachmentsByControllerId | () | método |
public function getAttachmentsByControllerId(id:String):IList| 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 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.
Parâmetros
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.
|
Elementos da API relacionados
getControllerById | () | método |
public function getControllerById(id:String, ns:String = null):Controller| 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 convenience method that searches through the contollers and returns the
controller with the matching id and XML namespace.
Parâmetros
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.
|
Elementos da API relacionados
getResourcesByControllerId | () | método |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| 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 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.
Parâmetros
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.
|
Elementos da API relacionados
getVersion | () | método |
packageObjectReady | () | método |
public function packageObjectReady(packageObject:IPackageObject):void| 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 |
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.
Parâmetros
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
Elementos da API relacionados
PACKAGE_VERSION_1_0 | Constante |
public static const PACKAGE_VERSION_1_0:Number = 1.0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Asset Placement Building Block 10 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 1.0.
PACKAGE_VERSION_2_0 | Constante |
public static const PACKAGE_VERSION_2_0:Number = 2.0| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Asset Placement Building Block 10 |
| Versões de runtime: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Wed Jun 13 2018, 11:10 AM Z