InvokeParams

包	com.adobe.icc.external.dc
类	public class InvokeParams
继承	InvokeParams EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

Formal definition of DC invocation parameters.

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	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 [只读] 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

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		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 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		addKeyPair(key:String, value:String):void Adds an entry to the ddkeMap for the specified key/value pair.	InvokeParams
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		encode():String Encodes the invocation parameters into a string of URL parameters separated by '&' characters.	InvokeParams
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String [覆盖] Provides a string representation of this class.	InvokeParams
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	事件		摘要	由以下参数定义
		activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
		deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher

公共常量

	常量		由以下参数定义
		MIN_PUBLISHED_VERSION : int = 1 [静态] Minimum published version of the Letter.	InvokeParams
		URLPARAM_DATA : String = "unknown" [静态] URL parameter pre-defined key name for inline initial XML data.	InvokeParams
		URLPARAM_DATAURL : String = "unknown" [静态] 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" [静态] URL parameter pre-defined key name for letter ID (GUID).	InvokeParams
		URLPARAM_LETTERNAME : String = "unknown" [静态] URL parameter pre-defined key name for letter name (version-independent).	InvokeParams
		URLPARAM_LETTERVERSION : String = "unknown" [静态] URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state).	InvokeParams
		URLPARAM_PREVIEW : String = "unknown" [静态] URL parameter pre-defined key name for specifying preview mode.	InvokeParams
		URLPARAM_USELATEST : String = "unknown" [静态] URL parameter pre-defined key name for using latest assets for previewing the specified letter.	InvokeParams
		URLPARAM_USETESTDATA : String = "unknown" [静态] URL parameter pre-defined key name for using test data for specified letter.	InvokeParams

属性详细信息

dataDebug

属性

dataDebug:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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).

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get dataDebug():Boolean
public function set dataDebug(value:Boolean):void

dataUrl

属性

dataUrl:String

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

Get/set the URL to the XML file to be used as initial data.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get dataUrl():String
public function set dataUrl(value:String):void

ddkeMap

属性

ddkeMap:Map

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get ddkeMap():Map
public function set ddkeMap(value:Map):void

debug

属性

debug:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get debug():Boolean
public function set debug(value:Boolean):void

fbDebug

属性

fbDebug:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

True if FormBridge should be run in debug mode.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get fbDebug():Boolean
public function set fbDebug(value:Boolean):void

fbDebugValue

属性

fbDebugValue:String

实现
icc_internal function get fbDebugValue():String
icc_internal function set fbDebugValue(value:String):void

hasInlineData

属性

hasInlineData:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get hasInlineData():Boolean
public function set hasInlineData(value:Boolean):void

invokeUrl

属性

invokeUrl:String [只读]

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

实现
public function get invokeUrl():String

letterId

属性

letterId:String

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

The ID (GUID) of the letter to fill. If specified, letterName, letterState and letterVersion are ignored.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get letterId():String
public function set letterId(value:String):void

letterName

属性

letterName:String

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

The name (version-independent) of the letter to fill.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get letterName():String
public function set letterName(value:String):void

letterVersion

属性

letterVersion:int

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

The version of the letter to fill.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get letterVersion():int
public function set letterVersion(value:int):void

preview

属性

preview:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

True if DC is being invoked in preview mode; false otherwise.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get preview():Boolean
public function set preview(value:Boolean):void

useLatest

属性

useLatest:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the latest assets/modules are to be used for previewing the specified letter.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get useLatest():Boolean
public function set useLatest(value:Boolean):void

useTestData

属性

useTestData:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the letter's test data should be used as the initial data.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get useTestData():Boolean
public function set useTestData(value:Boolean):void

xmlData

属性

xmlData:XML

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get xmlData():XML
public function set xmlData(value:XML):void

xmlDataSpecified

属性

xmlDataSpecified:Boolean

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get xmlDataSpecified():Boolean
public function set xmlDataSpecified(value:Boolean):void

构造函数详细信息

()

构造函数

public function InvokeParams(url:String = null)

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

参数

url:String (default = null) — The absolute url from which to extract the parameters. If null, defaults are used.

方法详细信息

addKeyPair

()

方法

public function addKeyPair(key:String, value:String):void

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

参数

	`key:String` — The name of the Data Dictionary Key Element.

	`value:String` — the value for the key.

encode

()

方法

public function encode():String

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

Encodes the invocation parameters into a string of URL parameters separated by '&' characters.

String — 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

()

方法

override public function toString():String

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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.

String — String representation of this class.

常量详细信息

MIN_PUBLISHED_VERSION

常量

public static const MIN_PUBLISHED_VERSION:int = 1

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

Minimum published version of the Letter.

URLPARAM_DATA

常量

public static const URLPARAM_DATA:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for inline initial XML data.

URLPARAM_DATAURL

常量

public static const URLPARAM_DATAURL:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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

常量

public static const URLPARAM_LETTERID:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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

常量

public static const URLPARAM_LETTERNAME:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for letter name (version-independent).

URLPARAM_LETTERVERSION

常量

public static const URLPARAM_LETTERVERSION:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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

常量

public static const URLPARAM_PREVIEW:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for specifying preview mode.

URLPARAM_USELATEST

常量

public static const URLPARAM_USELATEST:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

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

常量

public static const URLPARAM_USETESTDATA:String = "unknown"

语言版本:

ActionScript 3.0

产品版本:

Asset Composer Building Block 9.5

运行时版本:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for using test data for specified letter.

法律声明 | 在线隐私策略

InvokeParams - AS3 Asset Composer

类 x

dataDebug

dataUrl

ddkeMap

debug

fbDebug

fbDebugValue

hasInlineData

invokeUrl

letterId

letterName

letterVersion

preview

useLatest

useTestData

xmlData

xmlDataSpecified

InvokeParams

addKeyPair

encode

toString

MIN_PUBLISHED_VERSION

URLPARAM_DATA

URLPARAM_DATAURL

URLPARAM_LETTERID

URLPARAM_LETTERNAME

URLPARAM_LETTERVERSION

URLPARAM_PREVIEW

URLPARAM_USELATEST

URLPARAM_USETESTDATA