FragmentLayoutModel  - AS3 Asset Composer

The tables of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete event.

The fields of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the valueObjectChange event.

The file domain object associated with this fragmentLayout.

The file domain object is a representation of the XDP file that is uploaded by the user at the time of creation or updating of this fragmentLayout.

whether underlying value object is a flowed layout or not

This property can be used as the source for data binding. When this property is modified, it dispatches the valueObjectChange event.

Flag to indicate if the underlying value object is shallow.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

The tables of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the valueObjectChange event.

The target areas of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the valueObjectChange event.

Creates a copy of the domain object.

Note that this is different than cloning via ObjectUtil.copy() since a "copied" object needs to be saved via a specific server api.

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development. In some cases, the value objects could be shallow; for instance when obtained via Data Services. The complete value object could be requested by passing the fetchFromServer flag as true. In that case, the value object is obtained from the server via remoting call and the domain object shapes accordingly as the server response arrives.

Parameters

Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.

Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.

Indicates if the underlying value object is shallow.

Saves the underlying value object on the server.

Under the hood, separate calls are required for creating a new asset and copying or copying an existing one.

The save() method internally invokes the relevant server calls on the basis of its current state. The domain object constructed from the createFromVO() method would invoke the "update" api, the domain object starightaway instantiated on the client would inoke the "create" fragmentLayout api and the domain object obtained by the copy() method would internally call "copy api".

Invoking the save() implicitly invokes the validate() method to perform the necessary client side validations. Only when the client side validations are successful, is the actual save() call made. A save() method wouldn't proceed past the validation stage unless the object's state is made valid via user input or otherwise.

This method lets you inject a custom implementation of the infrastructure fragmentLayout service. By default, the class FragmentLayoutServiceDelegate is used as the infrastructure service.

Parameters

Dispatched when this Asset is completely fetched from the server. Assets are often kept shallow in the Asset Manager and fetched completely only when necessary. The fetchComplete event is dispatched when the Asset has been retrieved completely from the server.

Dispatched when the fragmentLayout is successfully saved.

The saveComplete event is dispatched when the domain object has been successfully saved on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

Dispatched when a fault occurs while saving the fragmentLayout.

The saveFault event is dispatched when the server reports an error while saving the asset on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

When this event is dispatched, the fault property contains the fault object encapsulating the error sent by the server. The fault property can be used to determine the faultCode and show an error message accordingly.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

Dispatched when the current fragmentLayout is requested for save. This event, being bubbling in nature, can be leveraged by the UI to display a progress bar or animation to indicate the save progress.

The saving event is dispatched when the save() method has been called on the domain object. This event is dispatched before any server api is invoked but after the domain client validations are complete. This is because the actual save starts once the client validations are complete.

This event can be used to start a UI animation indicating "save in progress".