| Paquete | com.adobe.icomm.assetplacement.model |
| Clase | public class PackageDefinition |
| Herencia | PackageDefinition  Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
Ocultar propiedades públicas heredadas
Mostrar propiedades públicas heredadas| Propiedad | Definido por | ||
|---|---|---|---|
| attachments : IList [solo lectura]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
 | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
| controllers : IList [solo lectura]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
| packageDefinitionFile : String [estática] [solo lectura]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
| packageLoaded : Boolean [solo lectura]
Check to see if the package is loaded. | PackageDefinition | ||
| resources : IList [solo lectura]
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 si un objeto tiene definida una propiedad especificada. | Object | |
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
| Constante | Definido por | ||
|---|---|---|---|
| PACKAGE_VERSION_1_0 : Number = 1.0 [estática] The package version 1.0. | PackageDefinition | ||
| PACKAGE_VERSION_2_0 : Number = 2.0 [estática] The package version 2.0. | PackageDefinition | ||
attachments | propiedad |
attachments:IList [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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.
Implementación
public function get attachments():IListElementos de API relacionados
controllers | propiedad |
controllers:IList [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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.
Implementación
public function get controllers():IListElementos de API relacionados
packageDefinitionFile | propiedad |
packageDefinitionFile:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Player 10 |
The file path of the package definition file that underlies this object.
Implementación
public static function get packageDefinitionFile():StringpackageLoaded | propiedad |
packageLoaded:Boolean [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Player 10 |
Check to see if the package is loaded.
Implementación
public function get packageLoaded():Booleanresources | propiedad |
resources:IList [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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.
Implementación
public function get resources():IListElementos de API relacionados
PackageDefinition | () | Información sobre |
public function PackageDefinition()| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
expiredResources | () | método |
public function expiredResources():IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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.
Valor devueltoIList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
Elementos de API relacionados
getAttachmentsByControllerId | () | método |
public function getAttachmentsByControllerId(id:String):IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
getControllerById | () | método |
public function getControllerById(id:String, ns:String = null):Controller| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
getResourcesByControllerId | () | método |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
getVersion | () | método |
packageObjectReady | () | método |
public function packageObjectReady(packageObject:IPackageObject):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 9.5 |
| Versiones de motor de ejecución: | 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 de API relacionados
PACKAGE_VERSION_1_0 | Constante |
public static const PACKAGE_VERSION_1_0:Number = 1.0| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 10 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Placement 10 |
| Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Tue Jun 12 2018, 02:12 PM Z