| Pacchetto | com.adobe.icomm.assetplacement.model |
| Classe | public class PackageDefinition |
| Ereditarietà | PackageDefinition  Object |
| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Elementi API correlati
Nascondi proprietà pubbliche ereditate
Mostra proprietà pubbliche ereditate| Proprietà | Definito da | ||
|---|---|---|---|
| attachments : IList [sola lettura]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
 | constructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto. | Object | |
| controllers : IList [sola lettura]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
| packageDefinitionFile : String [statico] [sola lettura]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
| packageLoaded : Boolean [sola lettura]
Check to see if the package is loaded. | PackageDefinition | ||
| resources : IList [sola lettura]
A list that contains all of the <resource> (non expired) entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
| Metodo | Definito da | ||
|---|---|---|---|
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 per un oggetto è definita una proprietà specifica. | Object | |
|
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro. | Object | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
Indica se la proprietà specificata esiste ed è enumerabile. | Object | |
|
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche. | Object | |
|
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate. | Object | |
|
Restituisce la rappresentazione in formato stringa dell'oggetto specificato. | Object | |
|
Restituisce il valore di base dell'oggetto specificato. | Object | |
| Costante | Definito da | ||
|---|---|---|---|
| PACKAGE_VERSION_1_0 : Number = 1.0 [statico] The package version 1.0. | PackageDefinition | ||
| PACKAGE_VERSION_2_0 : Number = 2.0 [statico] The package version 2.0. | PackageDefinition | ||
attachments | proprietà |
attachments:IList [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Implementazione
public function get attachments():IListElementi API correlati
controllers | proprietà |
controllers:IList [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Implementazione
public function get controllers():IListElementi API correlati
packageDefinitionFile | proprietà |
packageDefinitionFile:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni runtime: | AIR 1.0, Flash Player 9, Flash Player 10 |
The file path of the package definition file that underlies this object.
Implementazione
public static function get packageDefinitionFile():StringpackageLoaded | proprietà |
resources | proprietà |
resources:IList [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Implementazione
public function get resources():IListElementi API correlati
PackageDefinition | () | Funzione di costruzione |
public function PackageDefinition()| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Elementi API correlati
expiredResources | () | metodo |
public function expiredResources():IList| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
RestituisceIList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
Elementi API correlati
getAttachmentsByControllerId | () | metodo |
public function getAttachmentsByControllerId(id:String):IList| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Parametri
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.
|
Elementi API correlati
getControllerById | () | metodo |
public function getControllerById(id:String, ns:String = null):Controller| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Parametri
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.
|
Elementi API correlati
getResourcesByControllerId | () | metodo |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Parametri
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.
|
Elementi API correlati
getVersion | () | metodo |
packageObjectReady | () | metodo |
public function packageObjectReady(packageObject:IPackageObject):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 9.5 |
| Versioni 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.
Parametri
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
Elementi API correlati
PACKAGE_VERSION_1_0 | Costante |
public static const PACKAGE_VERSION_1_0:Number = 1.0| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 10 |
| Versioni runtime: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 1.0.
PACKAGE_VERSION_2_0 | Costante |
public static const PACKAGE_VERSION_2_0:Number = 2.0| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Blocco costitutivo Asset Placement 10 |
| Versioni runtime: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Tue Jun 12 2018, 02:44 PM Z