(Beta)
| Package | com.adobe.icc.services.layout |
| Interface | public interface ILayoutService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
Activates a form. | ILayoutService | ||
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
Creates a copy of an existing form. | ILayoutService | ||
Creates a new form. | ILayoutService | ||
Creates a test version of a form. | ILayoutService | ||
Deletes a form. | ILayoutService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Determines if the specified form exists. | ILayoutService | ||
Returns a list of available forms. | ILayoutService | ||
Retrieves a list of letters that are dependent on the specified form. | ILayoutService | ||
getDependentLettersForPrompt(fragmentLayoutId:String, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken
Retrieves specified number of letters that are dependent on the specified form. | ILayoutService | ||
Retrieves a form using its unique identifier. | ILayoutService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Updates the state of a form test. | ILayoutService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
activateForm | () | method |
public function activateForm(formId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Activates a form.
Parameters
formId:String — The identifier of the form to activate. The identifier is the GUID.
| |
updateDependencies:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — The updated Form.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
copyForm | () | method |
public function copyForm(oldFormID:String, newForm:Form):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a copy of an existing form.
Parameters
oldFormID:String — Identifier of form which is to be copied.
| |
newForm:Form — Optional. Specifies a new test data file, but the original XDP form cannot be altered.
|
com.adobe.icc.token:IAsyncToken — A new form object. That is, the copy.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createForm | () | method |
public function createForm(form:Form):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a new form.
Parameters
form:Form — The new form object.
|
com.adobe.icc.token:IAsyncToken — The new form object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createTestForm | () | method |
public function createTestForm(formID:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a test version of a form.
Parameters
formID:String — The identifier of an existing form to duplicate. The duplicate is used as a test version.
|
com.adobe.icc.token:IAsyncToken — The new Form object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
deleteForm | () | method |
public function deleteForm(formId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Deletes a form. If the form referenced by formId has the state test, it is physically deleted. If the state is active, the state is set to archive.
Parameters
formId:String — The identifier of the form to delete. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — Success in response if deleted successfully
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
formExists | () | method |
public function formExists(name:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Determines if the specified form exists.
Parameters
name:String — The name of the form. The name is not associated with any specific version.
|
com.adobe.icc.token:IAsyncToken — A Boolean that is true if the form exists. If the form does not exist, it is false.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getAllForms | () | method |
public function getAllForms(query:Query = null):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns a list of available forms.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection that contains Form objects.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLetters | () | method |
public function getDependentLetters(formId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a list of letters that are dependent on the specified form. That is, letters that use the specified form as their layout.
Parameters
formId:String — The unique identifier of the form associated with the dependent letters to retrieve.
|
com.adobe.icc.token:IAsyncToken — An ArrayCollection of Letter objects that are dependent on the specified form.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getDependentLettersForPrompt | () | method |
public function getDependentLettersForPrompt(fragmentLayoutId:String, maxAssetCount:int = 5, fetchOnlyTopLevelAttr:Boolean = true):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves specified number of letters that are dependent on the specified form. That is, letters that use the specified form as their layout.
Parameters
fragmentLayoutId:String — The unique identifier of the form associated with the dependent letters to retrieve.
| |
maxAssetCount:int (default = 5) | |
fetchOnlyTopLevelAttr:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — Object containing count of total dependent letters (against key 'Count') and List of Letters dependent on the given Fragment containing maximum
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getForm | () | method |
public function getForm(formId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a form using its unique identifier.
Parameters
formId:String — The unique identifier of the form to retrieve. That is, its GUID.
|
com.adobe.icc.token:IAsyncToken — If the ID is valid, the result event's result data is a Form object for the specified form.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
updateForm | () | method |
public function updateForm(form:Form):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Updates the state of a form test.
Parameters
form:Form — The updated form object.
|
com.adobe.icc.token:IAsyncToken — An updated form object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Wed Nov 21 2018, 06:34 AM -08:00