| Package | com.adobe.icomm.assetplacement.model |
| Classe | public class PackageDefinition |
| Héritage | PackageDefinition  Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
| attachments : IList [lecture seule]
A list that contains all of <attachment> entries in the package definition,
wrapped in Attachment objects. | PackageDefinition | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| controllers : IList [lecture seule]
A list that contains all of <controllers> entries in the package definition,
wrapped in Controller objects. | PackageDefinition | ||
| packageDefinitionFile : String [statique] [lecture seule]
The file path of the package definition file that underlies this object. | PackageDefinition | ||
| packageLoaded : Boolean [lecture seule]
Check to see if the package is loaded. | PackageDefinition | ||
| resources : IList [lecture seule]
A list that contains all of the <resource> (non expired) entries in the package definition,
wrapped in Resource objects. | PackageDefinition | ||
| Méthode | Défini par | ||
|---|---|---|---|
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 | ||
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
Broadcast an IPackageObjectReadyEvent. | PackageDefinition | ||
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
| Constante | Défini par | ||
|---|---|---|---|
| PACKAGE_VERSION_1_0 : Number = 1.0 [statique] The package version 1.0. | PackageDefinition | ||
| PACKAGE_VERSION_2_0 : Number = 2.0 [statique] The package version 2.0. | PackageDefinition | ||
attachments | propriété |
attachments:IList [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Implémentation
public function get attachments():IListEléments de l’API associés
controllers | propriété |
controllers:IList [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Implémentation
public function get controllers():IListEléments de l’API associés
packageDefinitionFile | propriété |
packageDefinitionFile:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Player 10 |
The file path of the package definition file that underlies this object.
Implémentation
public static function get packageDefinitionFile():StringpackageLoaded | propriété |
packageLoaded:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Player 10 |
Check to see if the package is loaded.
Implémentation
public function get packageLoaded():Booleanresources | propriété |
resources:IList [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Implémentation
public function get resources():IListEléments de l’API associés
PackageDefinition | () | Constructeur |
public function PackageDefinition()| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Eléments de l’API associés
expiredResources | () | méthode |
public function expiredResources():IList| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Valeur renvoyéeIList — A list of all the expired <resource> entries in the package definition,
wrapped in Resource objects.
|
Eléments de l’API associés
getAttachmentsByControllerId | () | méthode |
public function getAttachmentsByControllerId(id:String):IList| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
getControllerById | () | méthode |
public function getControllerById(id:String, ns:String = null):Controller| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
getResourcesByControllerId | () | méthode |
public function getResourcesByControllerId(id:String, includeExpired:Boolean = false):IList| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
getVersion | () | méthode |
packageObjectReady | () | méthode |
public function packageObjectReady(packageObject:IPackageObject):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
packageObject:IPackageObject — An IPackageObject that is loaded and ready to be used.
|
Eléments de l’API associés
PACKAGE_VERSION_1_0 | Constante |
public static const PACKAGE_VERSION_1_0:Number = 1.0| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 10 |
| Versions du moteur d’exécution: | 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| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Placement 10 |
| Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Player 10 |
The package version 2.0.
Tue Jun 12 2018, 09:30 AM Z