| 패키지 | com.adobe.icc.editors.model |
| 클래스 | public class LetterModel |
| 상속 | LetterModel  AssetModel EventDispatcher Object |
| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
상속되는 공용 속성 숨기기
상속되는 공용 속성 표시| 속성 | 정의 주체 | ||
|---|---|---|---|
 | activeEndDate : Date
The activeEndDate of the underlying value object. | AssetModel | |
| activeStartDate : Date
The activeStartDate date of the underlying value object. | AssetModel | |
| assignments : IList
The consolidated list of variable and field assignments of this letter. | LetterModel | ||
| 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 | |
| dataDictionary : DataDictionary
The typed DataDictionary object being used by this module. | LetterModel | ||
| dataDictionaryName : String
The name of the data dictionary being used by this module. | LetterModel | ||
| dataDictRegistryService : DataDictionaryRegistryService [정적]
The infrastructure service for data dictionary mainly used internally for
fetching data dictionary objects. | LetterModel | ||
| description : String
The description of the underlying value object. | AssetModel | |
| extendedProperties : Object
The extended properties of the underlying value object. | AssetModel | |
| fields : IList [읽기 전용]
Returns the list of fields in the base layout and all the container layouts. | LetterModel | ||
| 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 | |
| layout : LayoutModel
The domain object of the layout associated with this letter. | LetterModel | ||
| modules : IList [읽기 전용]
The list of data modules being referred in this letter. | LetterModel | ||
| name : String
The name of the underlying value object. | AssetModel | |
| postProcess : String
The postprocess to be executed. | LetterModel | ||
| service : ILetterService [정적]
The letter service instance that is used for saving/retrieving the letter
on the server. | LetterModel | ||
| state : int
The state of the underlying value object. | AssetModel | |
| staticEventDispatcher : IEventDispatcher [정적] [읽기 전용] | LetterModel | ||
| subCategory : Category
The Sub-Category of the underlying value object. | AssetModel | |
| targetAreaAssignments : IList
The list of target area assignments in this Letter. | LetterModel | ||
| testDataFile : FileModel
The test data file that supplies the preview data. | LetterModel | ||
| 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. | LetterModel | ||
[정적]
Creates the domain object from the corresponding value object. | LetterModel | ||
|
이벤트를 이벤트 흐름으로 전달합니다. | EventDispatcher | |
Returns the target area assignment domain object for the passed target area. | LetterModel | ||
Returns the list of variables being referred in this letter. | LetterModel | ||
|
EventDispatcher 객체에 특정 유형의 이벤트에 대한 리스너가 등록되어 있는지 여부를 확인합니다. | EventDispatcher | |
|
지정된 속성이 객체에 정의되어 있는지 여부를 나타냅니다. | Object | |
Indicates whether the data dictionary defined for this letter has been referred in
any of the assignments. | LetterModel | ||
The function indicates whether data dictionary is referenced in the nested layout. | LetterModel | ||
|
Object 클래스의 인스턴스가 매개 변수로 지정된 객체의 프로토타입 체인에 있는지 여부를 나타냅니다. | Object | |
|
지정된 속성이 존재하고 열거 가능한지 여부를 나타냅니다. | Object | |
|
EventDispatcher 객체에서 리스너를 제거합니다. | EventDispatcher | |
Resets all the assignment lists in this Letter. | LetterModel | ||
[재정의]
Saves the underlying value object on the server. | LetterModel | ||
Sets the data dictionary name to the one specified and also fetches the corresponding
DataDictionary object from the server. | LetterModel | ||
[정적]
This method lets you inject a custom implementation of the infrastructure data dictionary service. | LetterModel | ||
Sets the layout for this letter. | LetterModel | ||
[정적]
This method lets you inject a custom implementation of the infrastructure letter service. | LetterModel | ||
|
루프 작업에서 동적 속성을 사용할 수 있는지 여부를 설정합니다. | Object | |
|
로캘별 규칙에 따라 서식이 지정된 이 객체의 문자열 표현을 반환합니다. | Object | |
|
지정된 객체의 문자열 표현을 반환합니다. | Object | |
|
지정된 객체의 프리미티브 값을 반환합니다. | Object | |
|
이 EventDispatcher 객체 또는 조상 객체에 지정한 이벤트 유형에 대한 이벤트 리스너가 등록되어 있는지 여부를 확인합니다. | EventDispatcher | |
| 메서드 | 정의 주체 | ||
|---|---|---|---|
Fetches the data dictionary corresponding to the name specified. | LetterModel | ||
| 이벤트 | 요약 | 정의 주체 | ||
|---|---|---|---|---|
| [브로드캐스트 이벤트] Flash Player 또는 AIR 응용 프로그램이 운영 체제 포커스를 얻어 활성화될 때 전달됩니다. | EventDispatcher | ||
| [브로드캐스트 이벤트] Flash Player 또는 AIR 응용 프로그램이 운영 체제 포커스를 잃고 비활성화될 때 전달됩니다. | EventDispatcher | ||
| Dispatched when the letter has been completely fetched from the server. | LetterModel | |||
| Dispatched when a module assignment is added to any of the target area assignments. | LetterModel | |||
| Dispatched when a module assignment is removed from any of the target area assignments. | LetterModel | |||
| Dispatched when the letter is successfully saved. | LetterModel | |||
| Dispatched when a fault occurs while saving the letter. | LetterModel | |||
| Dispatched when the current letter is requested for save. | LetterModel | |||
assignments | 속성 |
assignments:IList| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The consolidated list of variable and field assignments of this letter.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 assignmentsChange 이벤트를 전달합니다.
구현
public function get assignments():IList public function set assignments(value:IList):voiddataDictionary | 속성 |
dataDictionary:DataDictionary| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The typed DataDictionary object being used by this module.
Assigning a value to this property updated the dataDictionaryName
as well but not the other way round.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 ddChange 이벤트를 전달합니다.
구현
public function get dataDictionary():DataDictionary public function set dataDictionary(value:DataDictionary):voiddataDictionaryName | 속성 |
dataDictionaryName:String| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name of the data dictionary being used by this module.
Merely setting this property wouldn't cause the dataDictionary
to be retrieved. If the dataDictionary needs to be updated,
setDataDictionaryName() method must be used instead.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 ddNameChange 이벤트를 전달합니다.
구현
public function get dataDictionaryName():String public function set dataDictionaryName(value:String):void관련 API 요소
dataDictRegistryService | 속성 |
dataDictRegistryService:DataDictionaryRegistryService| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The infrastructure service for data dictionary mainly used internally for fetching data dictionary objects.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 propertyChange 이벤트를 전달합니다.
구현
public static function get dataDictRegistryService():DataDictionaryRegistryService public static function set dataDictRegistryService(value:DataDictionaryRegistryService):voidfields | 속성 |
fields:IList [읽기 전용] | 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 10 |
| 런타임 버전: | AIR (unsupported), Flash Player 10.2 |
Returns the list of fields in the base layout and all the container layouts.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 fieldAssignmentsChange 이벤트를 전달합니다.
구현
public function get fields():IListlayout | 속성 |
layout:LayoutModel| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The domain object of the layout associated with this letter.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 propertyChange 이벤트를 전달합니다.
구현
public function get layout():LayoutModel public function set layout(value:LayoutModel):voidmodules | 속성 |
postProcess | 속성 |
service | 속성 |
service:ILetterService| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The letter service instance that is used for saving/retrieving the letter on the server. This service is internally invoked by the LetterModel class for performing CRUD operations.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 propertyChange 이벤트를 전달합니다.
구현
public static function get service():ILetterService public static function set service(value:ILetterService):voidstaticEventDispatcher | 속성 |
staticEventDispatcher:IEventDispatcher [읽기 전용] 구현
public static function get staticEventDispatcher():IEventDispatchertargetAreaAssignments | 속성 |
targetAreaAssignments:IList| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The list of target area assignments in this Letter.
이 속성은 데이터 바인딩에 대한 소스로 사용할 수 있습니다. 이 속성을 수정하면 targetAreaAssignmentsChange 이벤트를 전달합니다.
구현
public function get targetAreaAssignments():IList public function set targetAreaAssignments(value:IList):voidtestDataFile | 속성 |
copy | () | 메서드 |
public function copy():LetterModel| 언어 버전: | 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.
반환값LetterModel — A copy of current domain object.
|
createFromVO | () | 메서드 |
public static function createFromVO(letterVO:Letter, fetchFromServer:Boolean = true):LetterModel| 언어 버전: | 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.
매개 변수
letterVO:Letter — The value object of the type Letter
| |
fetchFromServer:Boolean (default = true) |
LetterModel — The Letter domain object corresponding the passed letter value object.
|
fetchDataDictionary | () | 메서드 |
protected function fetchDataDictionary():void| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the data dictionary corresponding to the name specified.
getTargetAreaAssignment | () | 메서드 |
public function getTargetAreaAssignment(area:*):com.adobe.icc.editors.model:TargetAreaAssignmentModel| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the target area assignment domain object for the passed target area.
매개 변수
area:* — The target area
|
com.adobe.icc.editors.model:TargetAreaAssignmentModel — The target area assignment domain object
|
getVariables | () | 메서드 |
public function getVariables():IList| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the list of variables being referred in this letter. This is a consolidated list of all the variables from all the referred modules.
반환값IList — The list of variables being referred in this letter
|
isDDReferenced | () | 메서드 |
public function isDDReferenced():Boolean| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Indicates whether the data dictionary defined for this letter has been referred in any of the assignments.
반환값Boolean — true, if the data dictionary is referred. false, otherwise.
|
isDDReferencedInNestedLayouts | () | 메서드 |
public function isDDReferencedInNestedLayouts(targetAreaAssignments:IList):Boolean| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 10.0 |
| 런타임 버전: | AIR (unsupported), Flash Player 10.2 |
The function indicates whether data dictionary is referenced in the nested layout.
매개 변수
targetAreaAssignments:IList — list of target area assignments
|
Boolean — flag indicating whether data dictionary is referenced in the nested layout.
|
resetAssignmentLists | () | 메서드 |
public function resetAssignmentLists(layout:LayoutModel):void| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Resets all the assignment lists in this Letter.
매개 변수
layout:LayoutModel — Layout Model
|
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" module 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.
setDataDictionaryName | () | 메서드 |
public function setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.
매개 변수
ddName:String — Name of the data dictionary
| |
fetchDataDictionary:Boolean (default = true) |
setDataDictRegistryService | () | 메서드 |
public static function setDataDictRegistryService(value:DataDictionaryRegistryService):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 data dictionary service.
By default, the class DataDictionaryRegistryServiceImpl is used as the infrastructure service.
매개 변수
value:DataDictionaryRegistryService — An implementation for DataDictionaryRegistryService.
|
setLayout | () | 메서드 |
public function setLayout(layout:LayoutModel, resetAssignments:Boolean = true):void| 언어 버전: | ActionScript 3.0 |
| 제품 버전: | Asset Composer Building Block 9.5 |
| 런타임 버전: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the layout for this letter.
매개 변수
layout:LayoutModel — The domain object of the layout that needs to be associated with this Letter
| |
resetAssignments:Boolean (default = true) |
setLetterService | () | 메서드 |
public static function setLetterService(value:ILetterService):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 letter service.
By default, the class LetterServiceDelegate is used as the infrastructure service.
매개 변수
value:ILetterService — An implementation for ILetterService.
|
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 the letter has been completely fetched from the server.
moduleAssignmentAdd | 이벤트 |
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 a module assignment is added to any of the target area assignments.
moduleAssignmentRemove | 이벤트 |
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 a module assignment is removed from any of the target area assignments.
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 letter 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 letter.
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 letter 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, 03:17 PM Z