| Package | com.adobe.icc.external.dc |
| Classe | public class InvokeParams |
| Héritage | InvokeParams  EventDispatcher Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| dataDebug : Boolean
True if DC should be run in data debug mode (which means the ICC Data is dumped to the Flash Log on every push to the PDF and inactive letters can be reloaded). | InvokeParams | ||
| dataUrl : String
Get/set the URL to the XML file to be used as initial data. | InvokeParams | ||
| ddkeMap : Map
Get/set Data Dictionary Key Element (ddke) Map: map of key/value pairs (String to String) provided for key elements whose values
are required in order to obtain an instance of the DD used by the letter. | InvokeParams | ||
| debug : Boolean
True if DC should be run in debug mode (which means, amongst other things, performance metrics are output and the "Load Letter" screen is displayed if
a letter isn't specified in the usual parameters. | InvokeParams | ||
| fbDebug : Boolean
True if FormBridge should be run in debug mode. | InvokeParams | ||
| hasInlineData : Boolean
Read-only. | InvokeParams | ||
| invokeUrl : String [lecture seule]
The invocation URL (should be absolute) or null if this InvokeParams object wasn't constructed from one. | InvokeParams | ||
| letterId : String
The ID (GUID) of the letter to fill. | InvokeParams | ||
| letterName : String
The name (version-independent) of the letter to fill. | InvokeParams | ||
| letterVersion : int
The version of the letter to fill. | InvokeParams | ||
| preview : Boolean
True if DC is being invoked in preview mode; false otherwise. | InvokeParams | ||
| useLatest : Boolean
True if the latest assets/modules are to be used for previewing the specified letter. | InvokeParams | ||
| useTestData : Boolean
True if the letter's test data should be used as the initial data. | InvokeParams | ||
| xmlData : XML
Get/set XML to be used as initial data. | InvokeParams | ||
| xmlDataSpecified : Boolean
True if XML data is specified in the URL (meaning at least one of xmlData or dataUrl is specified). | InvokeParams | ||
| Méthode | Défini par | ||
|---|---|---|---|
InvokeParams(url:String = null)
Determines the invocation parameters based on the specified URL. | InvokeParams | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
Adds an entry to the ddkeMap for the specified key/value pair. | InvokeParams | ||
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
Encodes the invocation parameters into a string of URL parameters separated by '&' characters. | InvokeParams | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
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 | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
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 | |
[override]
Provides a string representation of this class. | InvokeParams | ||
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
| Constante | Défini par | ||
|---|---|---|---|
| MIN_PUBLISHED_VERSION : int = 1 [statique]
Minimum published version of the Letter. | InvokeParams | ||
| URLPARAM_DATA : String = "unknown" [statique] URL parameter pre-defined key name for inline initial XML data. | InvokeParams | ||
| URLPARAM_DATAURL : String = "unknown" [statique]
URL parameter pre-defined key name for initial XML data file location (internal or external to host, must be absolute). | InvokeParams | ||
| URLPARAM_LETTERID : String = "unknown" [statique]
URL parameter pre-defined key name for letter ID (GUID). | InvokeParams | ||
| URLPARAM_LETTERNAME : String = "unknown" [statique]
URL parameter pre-defined key name for letter name (version-independent). | InvokeParams | ||
| URLPARAM_LETTERVERSION : String = "unknown" [statique]
URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state). | InvokeParams | ||
| URLPARAM_PREVIEW : String = "unknown" [statique]
URL parameter pre-defined key name for specifying preview mode. | InvokeParams | ||
| URLPARAM_USELATEST : String = "unknown" [statique]
URL parameter pre-defined key name for using latest assets for previewing the specified letter. | InvokeParams | ||
| URLPARAM_USETESTDATA : String = "unknown" [statique]
URL parameter pre-defined key name for using test data for specified letter. | InvokeParams | ||
dataDebug | propriété |
dataDebug:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if DC should be run in data debug mode (which means the ICC Data is dumped to the Flash Log on every push to the PDF and inactive letters can be reloaded).
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get dataDebug():Boolean public function set dataDebug(value:Boolean):voiddataUrl | propriété |
dataUrl:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get/set the URL to the XML file to be used as initial data.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get dataUrl():String public function set dataUrl(value:String):voidddkeMap | propriété |
ddkeMap:Map| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get/set Data Dictionary Key Element (ddke) Map: map of key/value pairs (String to String) provided for key elements whose values are required in order to obtain an instance of the DD used by the letter.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get ddkeMap():Map public function set ddkeMap(value:Map):voiddebug | propriété |
debug:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if DC should be run in debug mode (which means, amongst other things, performance metrics are output and the "Load Letter" screen is displayed if a letter isn't specified in the usual parameters.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get debug():Boolean public function set debug(value:Boolean):voidfbDebug | propriété |
fbDebug:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if FormBridge should be run in debug mode.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get fbDebug():Boolean public function set fbDebug(value:Boolean):voidfbDebugValue | propriété |
fbDebugValue:StringImplémentation
icc_internal function get fbDebugValue():String icc_internal function set fbDebugValue(value:String):voidhasInlineData | propriété |
hasInlineData:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Read-only. Determines if the invocation parameters include inline data such as XML data or a Data Dictionary Key Element Map.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get hasInlineData():Boolean public function set hasInlineData(value:Boolean):voidinvokeUrl | propriété |
invokeUrl:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The invocation URL (should be absolute) or null if this InvokeParams object wasn't constructed from one.
Implémentation
public function get invokeUrl():StringletterId | propriété |
letterId:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The ID (GUID) of the letter to fill. If specified, letterName, letterState and letterVersion
are ignored.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get letterId():String public function set letterId(value:String):voidletterName | propriété |
letterName:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name (version-independent) of the letter to fill.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get letterName():String public function set letterName(value:String):voidletterVersion | propriété |
letterVersion:int| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The version of the letter to fill.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get letterVersion():int public function set letterVersion(value:int):voidpreview | propriété |
preview:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if DC is being invoked in preview mode; false otherwise.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get preview():Boolean public function set preview(value:Boolean):voiduseLatest | propriété |
useLatest:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if the latest assets/modules are to be used for previewing the specified letter.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get useLatest():Boolean public function set useLatest(value:Boolean):voiduseTestData | propriété |
useTestData:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if the letter's test data should be used as the initial data.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get useTestData():Boolean public function set useTestData(value:Boolean):voidxmlData | propriété |
xmlData:XML| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get/set XML to be used as initial data. XML Data is passed-in as a URL-encoded string and is decoded into XML in this property.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get xmlData():XML public function set xmlData(value:XML):voidxmlDataSpecified | propriété |
xmlDataSpecified:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if XML data is specified in the URL (meaning at least one of xmlData or dataUrl is specified).
This is only valid if the data does not require prior knowledge of the letter in order to be accessed. This means that the
useTestData property has no baring on this property at all since using a letter's test data implies that the
letter ID or name/state/version is always specified. Furthermore, the existence of Data Dictionary Key Element pairs
(ddkeMap) has no influence on this property either.
Note: A value of true does not imply the specified data parameter provides existing and/or valid XML data.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get xmlDataSpecified():Boolean public function set xmlDataSpecified(value:Boolean):voidInvokeParams | () | Constructeur |
public function InvokeParams(url:String = null)| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines the invocation parameters based on the specified URL. If the app is currently running in a Flash Debug Player, a URL parameter with the name 'debug' will be ignored. Otherwise, it'll be treated as a DDKE key/value pair.
Paramètresurl:String (default = null) |
addKeyPair | () | méthode |
public function addKeyPair(key:String, value:String):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Adds an entry to the ddkeMap for the specified key/value pair. If the key already exists, the existing value is overwritten with the specified value.
Paramètres
key:String — The name of the Data Dictionary Key Element.
| |
value:String — the value for the key.
|
encode | () | méthode |
public function encode():String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Encodes the invocation parameters into a string of URL parameters separated by '&' characters.
Valeur renvoyéeString — URL parameter string representing the invocation parameters. If letterId is null, parameters
related to the letter, such as useTestData, xmlData, and ddkeMap, are not output.
|
toString | () | méthode |
override public function toString():String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Provides a string representation of this class. NOTE: This is meant for debugging, not encoding into a URL. Use the encode() method for that.
Valeur renvoyéeString — String representation of this class.
|
MIN_PUBLISHED_VERSION | Constante |
public static const MIN_PUBLISHED_VERSION:int = 1| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Minimum published version of the Letter.
URLPARAM_DATA | Constante |
public static const URLPARAM_DATA:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for inline initial XML data.
URLPARAM_DATAURL | Constante |
public static const URLPARAM_DATAURL:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for initial XML data file location (internal or external to host, must be absolute).
URLPARAM_LETTERID | Constante |
public static const URLPARAM_LETTERID:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for letter ID (GUID). If specified, overrides letter name, state and version.
URLPARAM_LETTERNAME | Constante |
public static const URLPARAM_LETTERNAME:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for letter name (version-independent).
URLPARAM_LETTERVERSION | Constante |
public static const URLPARAM_LETTERVERSION:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state).
URLPARAM_PREVIEW | Constante |
public static const URLPARAM_PREVIEW:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for specifying preview mode.
URLPARAM_USELATEST | Constante |
public static const URLPARAM_USELATEST:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for using latest assets for previewing the specified letter.
URLPARAM_USETESTDATA | Constante |
public static const URLPARAM_USETESTDATA:String = "unknown"| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for using test data for specified letter.
Tue Jun 12 2018, 09:30 AM Z