Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
com.adobe.icc.services.render 

ILetterRenderService  - AS3 Asset Composer

Pacotecom.adobe.icc.services.render
Interfacepublic interface ILetterRenderService extends IEventDispatcher

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: AIR (unsupported), Flash Player 9, Flash Player 10

Defines a service for rendering Letters to PDFs.



Métodos públicos
 MétodoDefinido por
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.
IEventDispatcher
 Inherited
Envia um evento para o fluxo de eventos.
IEventDispatcher
  
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
 Inherited
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Remove um ouvinte do objeto EventDispatcher.
IEventDispatcher
  
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer.
ILetterRenderService
  
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
 Inherited
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.
IEventDispatcher
Detalhes do método

getRenderedFileUrl

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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.

Parâmetros

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

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

Lança
Error — Invalid render response.
 
Error — Render response indicates a failure to render the letter.

Elementos da API relacionados

renderInteractiveLetter

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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.

Parâmetros

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.

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

Lança
Error — Letter ID is invalid.

Elementos da API relacionados

renderInteractiveLetterFromObject

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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.

Parâmetros

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.

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

Lança
Error — Letter ID is invalid.

Elementos da API relacionados

renderLetter

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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).

Parâmetros

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.

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

Lança
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.

Elementos da API relacionados

renderLetterFromObject

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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).

Parâmetros

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.

Retorna
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 renderLetterObjectToFile() method.

Lança
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.

Elementos da API relacionados

renderLetterObjectToFile

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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).

Parâmetros

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.

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

Lança
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.

Elementos da API relacionados

renderLetterToFile

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 9.5
Versões de runtime: 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).

Parâmetros

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.

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

Lança
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.

Elementos da API relacionados





[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.