Пакет | 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):void
dataDictionary | свойство |
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):void
dataDictionaryName | свойство |
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):void
fields | свойство |
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():IList
layout | свойство |
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):void
modules | свойство |
postProcess | свойство |
postProcess:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Asset Composer Building Block 9.5 |
Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The postprocess to be executed.
Реализация
public function get postProcess():String
public function set postProcess(value:String):void
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):void
staticEventDispatcher | свойство |
staticEventDispatcher:IEventDispatcher
[только для чтения] Реализация
public static function get staticEventDispatcher():IEventDispatcher
targetAreaAssignments | свойство |
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):void
testDataFile | свойство |
testDataFile:FileModel
Язык версии: | ActionScript 3.0 |
Версия продукта: | Asset Composer Building Block 9.5 |
Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The test data file that supplies the preview data.
Реализация
public function get testDataFile():FileModel
public function set testDataFile(value:FileModel):void
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 ) — Flag to indicate if the complete value object should be obtained from the server
|
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 ) — flag to indicate if the corresponding data dictionary object
needs to be fetched from the server.
|
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 ) — Whether the various assignment lists should be reset or not.
|
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, 11:34 AM Z