Paket | com.adobe.icc.services.render |
Schnittstelle | public interface ILetterRenderService extends IEventDispatcher |
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Methode | Definiert von | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird. | IEventDispatcher | ||
Sendet ein Ereignis in den Ereignisablauf. | 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 | ||
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat. | IEventDispatcher | ||
Entfernt einen Listener aus dem EventDispatcher-Objekt. | 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 | ||
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist. | IEventDispatcher |
getRenderedFileUrl | () | Methode |
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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.
Parameter
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.
|
Auslöser
Error — Invalid render response.
| |
Error — Render response indicates a failure to render the letter.
|
Verwandte API-Elemente
renderInteractiveLetter | () | Methode |
public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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.
Parameter
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.
|
Auslöser
Error — Letter ID is invalid.
|
Verwandte API-Elemente
renderInteractiveLetterFromObject | () | Methode |
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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.
Parameter
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.
|
Auslöser
Error — Letter ID is invalid.
|
Verwandte API-Elemente
renderLetter | () | Methode |
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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).
Parameter
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.
|
Auslöser
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.
|
Verwandte API-Elemente
renderLetterFromObject | () | Methode |
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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).
Parameter
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 — 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.
|
Auslöser
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.
|
Verwandte API-Elemente
renderLetterObjectToFile | () | Methode |
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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).
Parameter
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.
|
Auslöser
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.
|
Verwandte API-Elemente
renderLetterToFile | () | Methode |
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Sprachversion: | ActionScript 3.0 |
Produktversion: | Baustein „Asset Composer“ 9.5 |
Laufzeitversionen: | 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).
Parameter
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.
|
Auslöser
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.
|
Verwandte API-Elemente
Tue Jun 12 2018, 10:04 AM Z