ILetterRenderService - Adobe ActionScript® 3 (AS3 Asset Composer) API 참조 설명서

패키지	com.adobe.icc.services.render
인터페이스	public interface ILetterRenderService extends IEventDispatcher

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Defines a service for rendering Letters to PDFs.

공용 메서드

상속되는 공용 메서드 숨기기

상속되는 공용 메서드 표시

	메서드		정의 주체
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 리스너에서 이벤트 알림을 받을 수 있도록 EventDispatcher 객체에 이벤트 리스너 객체를 등록합니다.	IEventDispatcher
		dispatchEvent(event:Event):Boolean 이벤트를 이벤트 흐름으로 전달합니다.	IEventDispatcher
		getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client.	ILetterRenderService
		hasEventListener(type:String):Boolean EventDispatcher 객체에 특정 유형의 이벤트에 대한 리스너가 등록되어 있는지 여부를 확인합니다.	IEventDispatcher
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher 객체에서 리스너를 제거합니다.	IEventDispatcher
		renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken Render a given Letter as an augmented shell PDF for interactive use in Doc Composer.	ILetterRenderService
		renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken Render a given Letter as an augmented shell PDF for interactive use in Doc Composer.	ILetterRenderService
		renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).	ILetterRenderService
		renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).	ILetterRenderService
		renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).	ILetterRenderService
		renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).	ILetterRenderService
		willTrigger(type:String):Boolean 이 EventDispatcher 객체 또는 조상 객체에 지정한 이벤트 유형에 대한 이벤트 리스너가 등록되어 있는지 여부를 확인합니다.	IEventDispatcher

메서드 세부 정보

getRenderedFileUrl

()

메서드

public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client.

매개 변수

response:com.adobe.icc.vo.render:PDFResponseType — The response returned from a call to render a letter (via renderLetter(), for example).

반환값

com.adobe.icc.token:IAsyncToken — A string containing the URL to the rendered file.

오류

	`Error` — Invalid render response.

	`Error` — Render response indicates a failure to render the letter.

renderInteractiveLetter

()

메서드

public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. The PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter.

매개 변수

	`letterId:String` — ID (GUID) of the letter to render.

	`initialXmlData:String` (default = `null`) — Initial XML Data (IXD) to use in order to author appropriate target area data bindings based on the IXD's root element name. If not specified, target area data bindings will use the name of the root subform found in the Letter's Layout template.

반환값

com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

오류

Error — Letter ID is invalid.

renderInteractiveLetterFromObject

()

메서드

 public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

매개 변수

	`letter:Letter` — Fully populated Letter object with layout and assignments.

	`initialXmlData:String` (default = `null`) — Initial XML Data (IXD) to use in order to author appropriate target area data bindings based on the IXD's root element name. If not specified, target area data bindings will use the name of the root subform found in the Letter's Layout template.

반환값

com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

오류

Error — Letter ID is invalid.

renderLetter

()

메서드

 public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

매개 변수

	`letterId:String` — ID (GUID) of the letter to render.

	`mergeData:Boolean` (default = `false`) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.

	`initialXmlData:String` (default = `null`) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true.

	`useTestData:Boolean` (default = `false`) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Ignored if initialXmlData is not null.

	`interactive:Boolean` (default = `true`) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

반환값

com.adobe.icc.token:IAsyncToken — If mergeData is false, a PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file. If mergeData is true, the PDFResponseType object only contains information about the rendered file but not the file itself. To always get access the rendered PDF on the server, use the renderLetterToFile() method.

오류

	`Error` — Letter ID is invalid.

	`Error` — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).

	`Error` — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.

	`Error` — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

renderLetterFromObject

()

메서드

 public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

매개 변수

	`letter:Letter` — Fully populated Letter object with layout and assignments.

	`mergeData:Boolean` (default = `false`) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.

	`initialXmlData:String` (default = `null`) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true.

	`useTestData:Boolean` (default = `false`) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Ignored if initialXmlData is not null.

	`interactive:Boolean` (default = `true`) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

반환값

오류

	`Error` — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).

	`Error` — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.

	`Error` — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

renderLetterObjectToFile

()

메서드

 public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

매개 변수

	`letter:Letter` — Fully populated Letter object with layout and assignments.

	`mergeData:Boolean` (default = `false`) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.

	`initialXmlData:String` (default = `null`) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true.

	`useTestData:Boolean` (default = `false`) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Ignored if initialXmlData is not null.

	`interactive:Boolean` (default = `true`) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

반환값

com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

오류

	`Error` — Letter ID is invalid.

	`Error` — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).

	`Error` — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.

	`Error` — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

renderLetterToFile

()

메서드

 public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken

언어 버전:

ActionScript 3.0

제품 버전:

Asset Composer Building Block 9.5

런타임 버전:

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

Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).

매개 변수

	`letterId:String` — ID (GUID) of the letter to render.

	`mergeData:Boolean` (default = `false`) — If false, data-related parameters are ignored and the PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter. If true, some type of data must be given for rendering purposes.

	`initialXmlData:String` (default = `null`) — Initial XML Data to be merged with the Letter's Layout template. The data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true.

	`useTestData:Boolean` (default = `false`) — If true, the Letter's test data will be used as the Initial XML Data. This test data's schema is expected to match the schema of the Letter's Layout as well as the schema of the Letter's Data Dictionary (2010/Apr/08: this should not be a constraint but is currently imposed). Ignored if initialXmlData is not null.

	`interactive:Boolean` (default = `true`) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

반환값

com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl() method to get the full URL to the file.

오류

	`Error` — Letter ID is invalid.

	`Error` — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).

	`Error` — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.

	`Error` — The data supplied couldn't be used to initialize the Letter's Data Dictionary.

법적 고지 사항 | 온라인 개인 정보 보호 정책

ILetterRenderService - AS3 Asset Composer

클래스 x

getRenderedFileUrl

renderInteractiveLetter

renderInteractiveLetterFromObject

renderLetter

renderLetterFromObject

renderLetterObjectToFile

renderLetterToFile