| 包 | com.adobe.icc.editors.model |
| 类 | public class LayoutModel |
| 继承 | LayoutModel  AssetModel EventDispatcher Object |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
LayoutModel class represents the domain object for the assets of type Layout.
Domain objects can be leveraged to build presentation on top of them. They ease the
process of coding views by abstracting all the service calls and maintaining meaningful
states.
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | activeEndDate : Date
The activeEndDate of the underlying value object. | AssetModel | |
| activeStartDate : Date
The activeStartDate date of the underlying value object. | AssetModel | |
| category : Category
The Category of the underlying value object. | AssetModel | |
| comment : String
The comment of the underlying value object. | AssetModel | |
| constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| crxVersion : String
The crx version of the underlying value object. | AssetModel | |
| description : String
The description of the underlying value object. | AssetModel | |
| extendedProperties : Object
The extended properties of the underlying value object. | AssetModel | |
| fields : IList
The fields of the underlying value object. | LayoutModel | ||
| file : FileModel
The file domain object associated with this layout. | LayoutModel | ||
| id : String
The GUID of the underlying value object. | AssetModel | |
| isNew : Boolean
Indicates if this Asset is new. | AssetModel | |
| lastChangeBy : String
The lastChangeBy property of the underlying value object. | AssetModel | |
| name : String
The name of the underlying value object. | AssetModel | |
| state : int
The state of the underlying value object. | AssetModel | |
| subCategory : Category
The Sub-Category of the underlying value object. | AssetModel | |
| targetAreas : IList
The target areas of the underlying value object. | LayoutModel | ||
| version : int
The version of the underlying value object. | AssetModel | |
| vo : *
The value object which this asset domain object is built atop. | AssetModel | |
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | EventDispatcher | |
Creates a copy of the domain object. | LayoutModel | ||
[静态]
Creates the domain object from the corresponding value object. | LayoutModel | ||
|
将事件调度到事件流中。 | EventDispatcher | |
Fetches the complete value object via remoting call. | LayoutModel | ||
|
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | |
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
Indicates if the underlying value object is shallow. | LayoutModel | ||
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | |
[覆盖]
Saves the underlying value object on the server. | LayoutModel | ||
[静态]
This method lets you inject a custom implementation of the infrastructure layout service. | LayoutModel | ||
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
|
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher | |
| 事件 | 摘要 | 由以下参数定义 | ||
|---|---|---|---|---|
| [广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。 | EventDispatcher | ||
| [广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。 | EventDispatcher | ||
| Dispatched when this Asset is completely fetched from the server. | LayoutModel | |||
| Dispatched when the layout is successfully saved. | LayoutModel | |||
| Dispatched when a fault occurs while saving the layout. | LayoutModel | |||
| Dispatched when the current layout is requested for save. | LayoutModel | |||
fields | 属性 |
fields:IList| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The fields of the underlying value object.
此属性可用作数据绑定的源。修改此属性后，将调度 valueObjectChange 事件。
实现
public function get fields():IList public function set fields(value:IList):voidfile | 属性 |
file:FileModel| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The file domain object associated with this layout.
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 layout.
实现
public function get file():FileModel public function set file(value:FileModel):voidtargetAreas | 属性 |
targetAreas:IList| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The target areas of the underlying value object.
此属性可用作数据绑定的源。修改此属性后，将调度 valueObjectChange 事件。
实现
public function get targetAreas():IList public function set targetAreas(value:IList):voidcopy | () | 方法 |
public function copy():LayoutModel| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
返回LayoutModel — A copy of current domain object.
|
createFromVO | () | 方法 |
public static function createFromVO(layoutVO:Form, fetchFromServer:Boolean = true):LayoutModel| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
参数
layoutVO:Form — The value object of the type Form
| |
fetchFromServer:Boolean (default = true) |
LayoutModel — The Layout domain object corresponding the passed Layout value object.
|
fetchFromServer | () | 方法 |
public function fetchFromServer():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.
isShallow | () | 方法 |
save | () | 方法 |
override public function save():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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" layout 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.
setLayoutService | () | 方法 |
public static function setLayoutService(value:ILayoutService):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This method lets you inject a custom implementation of the infrastructure layout service.
By default, the class LayoutServiceDelegate is used as the infrastructure service.
参数
value:ILayoutService — An implementation for ILayoutService.
|
fetchComplete | 事件 |
flash.events.Event属性 Event.type =
flash.events.Event| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
saveComplete | 事件 |
com.adobe.icc.editors.events.AssetEvent属性 AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the layout is successfully saved.
TheAssetEvent.SAVE_COMPLETE constant defines the value of the
type property of the event object for a saveComplete event.
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.
saveFault | 事件 |
com.adobe.icc.editors.events.AssetEvent属性 AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a fault occurs while saving the layout.
TheAssetEvent.SAVE_FAULT constant defines the value of the
type property of the event object for a saveFault event.
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.
saving | 事件 |
com.adobe.icc.editors.events.AssetEvent属性 AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVING| 语言版本: | ActionScript 3.0 |
| 产品版本: | Asset Composer Building Block 9.5 |
| 运行时版本: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the current layout 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.
TheAssetEvent.SAVING constant defines the value of the
type property of the event object for a saving event.
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".
Tue Jun 12 2018, 11:04 AM Z