Pakket | com.adobe.icc.external.dc |
Klasse | public class InvokeParams |
Overerving | InvokeParams EventDispatcher Object |
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Eigenschap | Gedefinieerd door | ||
---|---|---|---|
constructor : Object
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | 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 [alleen-lezen]
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 |
Methode | Gedefinieerd door | ||
---|---|---|---|
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
Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt. | EventDispatcher | ||
Adds an entry to the ddkeMap for the specified key/value pair. | InvokeParams | ||
Verzendt een gebeurtenis naar de gebeurtenisstroom. | EventDispatcher | ||
Encodes the invocation parameters into a string of URL parameters separated by '&' characters. | InvokeParams | ||
Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis. | EventDispatcher | ||
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | Object | ||
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | ||
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | ||
Verwijdert een listener uit het object EventDispatcher. | EventDispatcher | ||
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | ||
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | ||
[overschrijven]
Provides a string representation of this class. | InvokeParams | ||
Retourneert de primitieve waarde van het opgegeven object. | Object | ||
Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis. | EventDispatcher |
Constante | Gedefinieerd door | ||
---|---|---|---|
MIN_PUBLISHED_VERSION : int = 1 [statisch]
Minimum published version of the Letter. | InvokeParams | ||
URLPARAM_DATA : String = "unknown" [statisch] URL parameter pre-defined key name for inline initial XML data. | InvokeParams | ||
URLPARAM_DATAURL : String = "unknown" [statisch]
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" [statisch]
URL parameter pre-defined key name for letter ID (GUID). | InvokeParams | ||
URLPARAM_LETTERNAME : String = "unknown" [statisch]
URL parameter pre-defined key name for letter name (version-independent). | InvokeParams | ||
URLPARAM_LETTERVERSION : String = "unknown" [statisch]
URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state). | InvokeParams | ||
URLPARAM_PREVIEW : String = "unknown" [statisch]
URL parameter pre-defined key name for specifying preview mode. | InvokeParams | ||
URLPARAM_USELATEST : String = "unknown" [statisch]
URL parameter pre-defined key name for using latest assets for previewing the specified letter. | InvokeParams | ||
URLPARAM_USETESTDATA : String = "unknown" [statisch]
URL parameter pre-defined key name for using test data for specified letter. | InvokeParams |
dataDebug | eigenschap |
dataDebug:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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).
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get dataDebug():Boolean
public function set dataDebug(value:Boolean):void
dataUrl | eigenschap |
dataUrl:String
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Get/set the URL to the XML file to be used as initial data.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get dataUrl():String
public function set dataUrl(value:String):void
ddkeMap | eigenschap |
ddkeMap:Map
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get ddkeMap():Map
public function set ddkeMap(value:Map):void
debug | eigenschap |
debug:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get debug():Boolean
public function set debug(value:Boolean):void
fbDebug | eigenschap |
fbDebug:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if FormBridge should be run in debug mode.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get fbDebug():Boolean
public function set fbDebug(value:Boolean):void
fbDebugValue | eigenschap |
fbDebugValue:String
Implementatie
icc_internal function get fbDebugValue():String
icc_internal function set fbDebugValue(value:String):void
hasInlineData | eigenschap |
hasInlineData:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get hasInlineData():Boolean
public function set hasInlineData(value:Boolean):void
invokeUrl | eigenschap |
invokeUrl:String
[alleen-lezen] Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Implementatie
public function get invokeUrl():String
letterId | eigenschap |
letterId:String
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The ID (GUID) of the letter to fill. If specified, letterName
, letterState
and letterVersion
are ignored.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get letterId():String
public function set letterId(value:String):void
letterName | eigenschap |
letterName:String
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name (version-independent) of the letter to fill.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get letterName():String
public function set letterName(value:String):void
letterVersion | eigenschap |
letterVersion:int
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The version of the letter to fill.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get letterVersion():int
public function set letterVersion(value:int):void
preview | eigenschap |
preview:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if DC is being invoked in preview mode; false otherwise.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get preview():Boolean
public function set preview(value:Boolean):void
useLatest | eigenschap |
useLatest:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if the latest assets/modules are to be used for previewing the specified letter.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get useLatest():Boolean
public function set useLatest(value:Boolean):void
useTestData | eigenschap |
useTestData:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
True if the letter's test data should be used as the initial data.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get useTestData():Boolean
public function set useTestData(value:Boolean):void
xmlData | eigenschap |
xmlData:XML
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get xmlData():XML
public function set xmlData(value:XML):void
xmlDataSpecified | eigenschap |
xmlDataSpecified:Boolean
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange
verzonden.
Implementatie
public function get xmlDataSpecified():Boolean
public function set xmlDataSpecified(value:Boolean):void
InvokeParams | () | Constructor |
public function InvokeParams(url:String = null)
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Parametersurl:String (default = null ) — The absolute url from which to extract the parameters. If null, defaults are used.
|
addKeyPair | () | methode |
public function addKeyPair(key:String, value:String):void
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Parameters
key:String — The name of the Data Dictionary Key Element.
| |
value:String — the value for the key.
|
encode | () | methode |
public function encode():String
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Encodes the invocation parameters into a string of URL parameters separated by '&' characters.
Geretourneerde waardeString — 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 | () | methode |
override public function toString():String
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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.
Geretourneerde waardeString — String representation of this class.
|
MIN_PUBLISHED_VERSION | Constante |
public static const MIN_PUBLISHED_VERSION:int = 1
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Minimum published version of the Letter.
URLPARAM_DATA | Constante |
public static const URLPARAM_DATA:String = "unknown"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | 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"
Taalversie: | ActionScript 3.0 |
Productversie: | Asset Composer Building Block 9.5 |
Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
URL parameter pre-defined key name for using test data for specified letter.
Wed Jun 13 2018, 11:42 AM Z