パッケージ | com.adobe.icc.editors.model |
クラス | public class FragmentLayoutModel |
継承 | FragmentLayoutModel AssetModel EventDispatcher Object |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
FragmentLayoutModel
class represents the domain object for the assets of type FragmentLayout.
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 | ||
cutsomizedLayout : Boolean
The tables of the underlying value object. | FragmentLayoutModel | ||
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. | FragmentLayoutModel | ||
file : FileModel
The file domain object associated with this fragmentLayout. | FragmentLayoutModel | ||
flowedLayout : Boolean
whether underlying value object is a flowed layout or not
| FragmentLayoutModel | ||
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 | ||
shallow : Boolean
Flag to indicate if the underlying value object is shallow. | FragmentLayoutModel | ||
state : int
The state of the underlying value object. | AssetModel | ||
subCategory : Category
The Sub-Category of the underlying value object. | AssetModel | ||
tables : IList
The tables of the underlying value object. | FragmentLayoutModel | ||
targetAreas : IList
The target areas of the underlying value object. | FragmentLayoutModel | ||
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. | FragmentLayoutModel | ||
[静的]
Creates the domain object from the corresponding value object. | FragmentLayoutModel | ||
イベントをイベントフローに送出します。 | EventDispatcher | ||
Fetches the complete value object via remoting call. | FragmentLayoutModel | ||
Fetches the complete value object via remoting call. | FragmentLayoutModel | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
Indicates if the underlying value object is shallow. | FragmentLayoutModel | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | ||
[オーバーライド]
Saves the underlying value object on the server. | FragmentLayoutModel | ||
[静的]
This method lets you inject a custom implementation of the infrastructure fragmentLayout service. | FragmentLayoutModel | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher |
イベント | 概要 | 定義元 | ||
---|---|---|---|---|
[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。 | EventDispatcher | |||
[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。 | EventDispatcher | |||
Dispatched when this Asset is completely fetched from the server. | FragmentLayoutModel | |||
Dispatched when the fragmentLayout is successfully saved. | FragmentLayoutModel | |||
Dispatched when a fault occurs while saving the fragmentLayout. | FragmentLayoutModel | |||
Dispatched when the current fragmentLayout is requested for save. | FragmentLayoutModel |
cutsomizedLayout | プロパティ |
cutsomizedLayout:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
The tables of the underlying value object.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 fetchComplete
イベントが送出されます。
実装
public function get cutsomizedLayout():Boolean
public function set cutsomizedLayout(value:Boolean):void
fields | プロパティ |
fields:IList
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
The fields of the underlying value object.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 valueObjectChange
イベントが送出されます。
実装
public function get fields():IList
public function set fields(value:IList):void
file | プロパティ |
file:FileModel
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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.
実装
public function get file():FileModel
public function set file(value:FileModel):void
flowedLayout | プロパティ |
flowedLayout:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
whether underlying value object is a flowed layout or not
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 valueObjectChange
イベントが送出されます。
実装
public function get flowedLayout():Boolean
public function set flowedLayout(value:Boolean):void
shallow | プロパティ |
shallow:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
Flag to indicate if the underlying value object is shallow.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get shallow():Boolean
public function set shallow(value:Boolean):void
tables | プロパティ |
tables:IList
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
The tables of the underlying value object.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 valueObjectChange
イベントが送出されます。
実装
public function get tables():IList
public function set tables(value:IList):void
targetAreas | プロパティ |
targetAreas:IList
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
The target areas of the underlying value object.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 valueObjectChange
イベントが送出されます。
実装
public function get targetAreas():IList
public function set targetAreas(value:IList):void
copy | () | メソッド |
public function copy():FragmentLayoutModel
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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.
戻り値FragmentLayoutModel — A copy of current domain object.
|
createFromVO | () | メソッド |
public static function createFromVO(fragmentLayoutVO:FragmentLayout, fetchFromServer:Boolean = true):FragmentLayoutModel
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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.
パラメーター
fragmentLayoutVO:FragmentLayout — The value object of the type FragmentLayout
| |
fetchFromServer:Boolean (default = true ) — Flag to indicate if the complete value object should be obtained from the server
|
FragmentLayoutModel — The FragmentLayout domain object corresponding the passed FragmentLayout value object.
|
fetchComplete | () | メソッド |
public function fetchComplete():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.
fetchFromServer | () | メソッド |
public function fetchFromServer():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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.
setFragmentLayoutService | () | メソッド |
public static function setFragmentLayoutService(value:IFragmentLayoutService):void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10.0 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
This method lets you inject a custom implementation of the infrastructure fragmentLayout service.
By default, the class FragmentLayoutServiceDelegate
is used as the infrastructure service.
パラメーター
value:IFragmentLayoutService — An implementation for IFragmentLayoutService.
|
fetchComplete | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Asset Composer Building Block 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
Dispatched when the fragmentLayout 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 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
Dispatched when a fault occurs while saving the fragmentLayout.
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 10 |
ランタイムバージョン: | AIR (unsupported), Flash Player 10.2 |
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.
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, 10:34 AM Z