Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター： サーバーからデータを取得しています...
サーバーからデータを取得しています...
com.adobe.icc.external.dc 

InvokeParams  - AS3 Asset Composer
パッケージcom.adobe.icc.external.dc
クラスpublic class InvokeParams
継承InvokeParams Inheritance EventDispatcher Inheritance Object

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Formal definition of DC invocation parameters.


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : 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
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
  
encode():String
Encodes the invocation parameters into a string of URL parameters separated by '&' characters.
InvokeParams
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toLocaleString():String
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
  
toString():String
[オーバーライド] Provides a string representation of this class.
InvokeParams
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
イベントの詳細についてはここをクリックしてください
 イベント 概要 定義元
 Inherited
activate
[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited
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
コンストラクターの詳細

InvokeParams

()コンストラクター
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.




© 2015 Adobe Systems Incorporated. All rights reserved.
Tue Jun 12 2018, 10:34 AM Z
 

 

法律上の注意 | プライバシーポリシー
[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。