(Beta)
| Package | com.adobe.icc.services.fragmentlayout |
| Interface | public interface IFragmentLayoutService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
activateFragmentLayout(fragmentLayoutId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken
Activates a fragmentLayout template
| IFragmentLayoutService | ||
 | 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 | |
copyFragmentLayout(oldFragmentLayoutID:String, newFragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken
Creates a copy of an existing fragmentLayout. | IFragmentLayoutService | ||
Creates a new fragmentLayout template record
| IFragmentLayoutService | ||
For creating a test version of a fragmentLayout template. | IFragmentLayoutService | ||
Allows deleting of a fragmentLayout. | IFragmentLayoutService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Determines if the specified fragmentLayout exists. | IFragmentLayoutService | ||
Returns a list of available fragmentLayout templates. | IFragmentLayoutService | ||
Retrieves a list of letters that are dependent on the specified fragmentLayout (i.e. | IFragmentLayoutService | ||
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 fragmentLayout (i.e. | IFragmentLayoutService | ||
Retrieves a fragmentLayout given its unique identifier. | IFragmentLayoutService | ||
Retrieves a fragmentLayout given its unique identifier and date on which the fragment was published. | IFragmentLayoutService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Parses fragment layout and populates target areas, fields and tables in it. | IFragmentLayoutService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Allows updating a fragmentLayout template with state test
| IFragmentLayoutService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
activateFragmentLayout | () | method |
public function activateFragmentLayout(fragmentLayoutId:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Activates a fragmentLayout template
Parameters
fragmentLayoutId:String — The ID (GUID) of the fragmentLayout to activate
| |
updateDependencies:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — the updated FragmentLayout
|
Throws
Error | |
Error | |
Error |
copyFragmentLayout | () | method |
public function copyFragmentLayout(oldFragmentLayoutID:String, newFragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Creates a copy of an existing fragmentLayout.
Parameters
oldFragmentLayoutID:String | |
newFragmentLayout:FragmentLayout — may optionally specify a new test data file but original XDP fragmentLayout cannot be altered
|
com.adobe.icc.token:IAsyncToken — New fragmentLayout object (the copy).
|
Throws
Error | |
Error | |
Error |
createFragmentLayout | () | method |
public function createFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Creates a new fragmentLayout template record
Parameters
fragmentLayout:FragmentLayout — New fragmentLayout object
|
com.adobe.icc.token:IAsyncToken — The new FragmentLayout object
|
Throws
Error | |
Error | |
Error | |
Error |
createTestFragmentLayout | () | method |
public function createTestFragmentLayout(fragmentLayoutID:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
For creating a test version of a fragmentLayout template.
Parameters
fragmentLayoutID:String — The ID (GUID) of an existing FragmentLayout to duplicate as a test version
|
com.adobe.icc.token:IAsyncToken — The new FragmentLayout object
|
Throws
Error | |
Error | |
Error | |
Error |
deleteFragmentLayout | () | method |
public function deleteFragmentLayout(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Allows deleting of a fragmentLayout. If the fragmentLayout referenced by fragmentLayoutId has the state test it is physically deleted otherwise if the state is active it is being set to state archive.
Parameters
fragmentLayoutId:String — The ID (GUID) of the fragmentLayout to delete
|
com.adobe.icc.token:IAsyncToken —
|
Throws
Error | |
Error | |
Error | |
Error |
fragmentLayoutExists | () | method |
public function fragmentLayoutExists(name:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Determines if the specified fragmentLayout exists.
Parameters
name:String — Version-independent name of the fragmentLayout.
|
com.adobe.icc.token:IAsyncToken — Boolean which is true if the fragmentLayout exists; false if not.
|
Throws
Error |
getAllFragmentLayouts | () | method |
public function getAllFragmentLayouts(query:Query = null):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Returns a list of available fragmentLayout templates.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection containing FragmentLayout objects
|
Throws
Error | |
Error | |
Error |
getDependentLetters | () | method |
public function getDependentLetters(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieves a list of letters that are dependent on the specified fragmentLayout (i.e. that use the specified fragmentLayout as their layout).
Parameters
fragmentLayoutId:String — The unique identifer of the fragmentLayout whose dependent letters are sought.
|
com.adobe.icc.token:IAsyncToken — ArrayCollection of Letter objects that are dependent on the specified fragmentLayout.
|
Throws
Error |
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieves specified number of letters that are dependent on the specified fragmentLayout (i.e. that use the specified fragmentLayout as their layout).
Parameters
fragmentLayoutId:String — The unique identifer of the fragmentLayout whose dependent letters are sought.
| |
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 |
getFragmentLayout | () | method |
public function getFragmentLayout(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieves a fragmentLayout given its unique identifier.
Parameters
fragmentLayoutId:String — The unique identifier of the fragmentLayout to retrieve (i.e. it's GUID).
|
com.adobe.icc.token:IAsyncToken — The result event's result data will be a FragmentLayout object for the specified fragmentLayout, if the ID was valid.
|
Throws
Error | |
Error | |
Error |
getFragmentLayoutByVersion | () | method |
public function getFragmentLayoutByVersion(fragmentLayoutId:String, date:Date):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Retrieves a fragmentLayout given its unique identifier and date on which the fragment was published.
Parameters
fragmentLayoutId:String — The unique identifier of the fragmentLayout to retrieve (i.e. it's GUID).
| |
date:Date — The date on which the fragment was published.
|
com.adobe.icc.token:IAsyncToken — The result event's result data will be a FragmentLayout object for the specified fragmentLayout, if the ID was valid.
|
Throws
Error | |
Error | |
Error |
parseFragmentLayout | () | method |
public function parseFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Parses fragment layout and populates target areas, fields and tables in it.
Parameters
fragmentLayout:FragmentLayout — FragmentLayout required to be parsed
|
com.adobe.icc.token:IAsyncToken — FragmentLayout populated with target areas, fields and tables.
|
updateFragmentLayout | () | method |
public function updateFragmentLayout(fragmentLayout:FragmentLayout):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Allows updating a fragmentLayout template with state test
Parameters
fragmentLayout:FragmentLayout — Updated fragmentLayout object
|
com.adobe.icc.token:IAsyncToken — Updated fragmentLayout object
|
Throws
Error | |
Error | |
Error |
Wed Nov 21 2018, 06:34 AM -08:00