適用於 Adobe® Flash® Platform 的 ActionScript® 3.0 參考
首頁  |  隱藏套件和類別清單 |  套件  |  類別  |  新增內容  |  索引  |  附錄  |  為什麼顯示英文?
篩選: 從伺服器擷取資料...
從伺服器擷取資料...
com.adobe.icc.editors.model 

TextModel  - AS3 Asset Composer

套件com.adobe.icc.editors.model
類別public class TextModel
繼承TextModel Inheritance ModuleModel Inheritance AssetModel Inheritance EventDispatcher Inheritance Object

語言版本: ActionScript 3.0
產品版本: Asset Composer Building Block 9.5
執行階段版本: AIR (unsupported), Flash Player 9, Flash Player 10

The TextModel class represents the domain object for the assets of type Text. 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.



公用屬性
 屬性定義自
 InheritedactiveEndDate : Date
The activeEndDate of the underlying value object.
AssetModel
 InheritedactiveStartDate : Date
The activeStartDate date of the underlying value object.
AssetModel
 Inheritedcategory : Category
The Category of the underlying value object.
AssetModel
 Inheritedcomment : String
The comment of the underlying value object.
AssetModel
 Inheritedconstructor : Object
類別物件的參照或是特定物件實體的建構函數。
Object
 InheritedcrxVersion : String
The crx version of the underlying value object.
AssetModel
 InheriteddataDictionary : DataDictionary
The typed DataDictionary object being used by this module.
ModuleModel
 InheriteddataDictionaryName : String
The name of the data dictionary being used by this module.
ModuleModel
 Inheriteddescription : String
The description of the underlying value object.
AssetModel
  editorData : EditorResult
Represents that data held by the Rich Text Editor.
TextModel
 InheritedextendedProperties : Object
The extended properties of the underlying value object.
AssetModel
 Inheritedid : String
The GUID of the underlying value object.
AssetModel
  isDDReferenced : Boolean
Indicates whether the data dictionary defined for this text has been referred in any of the assignments.
TextModel
 InheritedisNew : Boolean
Indicates if this Asset is new.
AssetModel
 InheritedlastChangeBy : String
The lastChangeBy property of the underlying value object.
AssetModel
 Inheritedname : String
The name of the underlying value object.
AssetModel
  service : IModuleService
[靜態] The module service instance that is used for saving/retrieving the module on the server.
TextModel
 Inheritedshallow : Boolean
Flag to indicate if the underlying value object is shallow.
ModuleModel
 Inheritedstate : int
The state of the underlying value object.
AssetModel
 InheritedsubCategory : Category
The Sub-Category of the underlying value object.
AssetModel
 Inheritedvariables : IList
[唯讀] The variables defined within this module.
ModuleModel
 Inheritedversion : int
The version of the underlying value object.
AssetModel
 Inheritedvo : *
The value object which this asset domain object is built atop.
AssetModel
保護屬性
 屬性定義自
 InheritedisCopy : Boolean
Indicates that the object is a copy of an existing Asset.
AssetModel
 InheritedoldId : String
Id of the Asset which was cloned to create this copy.
AssetModel
 InheritedpreferencesManager : PreferencesManager
To manage user preferences for category, subcategory and data dictionary.
AssetModel
公用方法
 方法定義自
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。
EventDispatcher
  
Creates a copy of the domain object.
TextModel
 Inherited
[靜態] Fetches a module by the given id and constructs the domain module object on top of it.
ModuleModel
  
[靜態] Creates the domain object from the corresponding value object.
TextModel
 Inherited
會將事件傳送到事件流程。
EventDispatcher
  
[覆寫] Fetches the complete value object via remoting call.
TextModel
 Inherited
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。
EventDispatcher
 Inherited
指出物件是否有已定義的指定屬性。
Object
 Inherited
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。
Object
 Inherited
Indicates if the underlying value object is shallow.
ModuleModel
 Inherited
指出指定的屬性是否存在,以及是否可列舉。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
會從 EventDispatcher 物件移除偵聽程式。
EventDispatcher
  
[覆寫] Saves the underlying value object on the server.
TextModel
 Inherited
setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void
Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.
ModuleModel
 Inherited
[靜態] This method lets you inject a custom implementation of the infrastructure data dictionary service.
ModuleModel
  
[靜態] This method lets you inject a custom implementation of the infrastructure module service.
TextModel
 Inherited
為迴圈作業設定動態屬性的可用性。
Object
 Inherited
傳回代表此物件的字串,根據地區特定慣例進行格式化。
Object
 Inherited
會傳回指定之物件的字串形式。
Object
 Inherited
Runs the client validations and raises events of the type AssetValidationEvent for notifying validation result.
ModuleModel
 Inherited
會傳回指定之物件的基本值。
Object
 Inherited
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。
EventDispatcher
保護方法
 方法定義自
 Inherited
Fetches the data dictionary corresponding to the name specified.
ModuleModel
事件
 事件 摘要 定義自
 Inherited[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。EventDispatcher
 Inherited[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。EventDispatcher
  Dispatched when this Asset is completely fetched from the server.TextModel
  Dispatched when the text is successfully saved.TextModel
  Dispatched when a fault occurs while saving the text.TextModel
  Dispatched when the current text is requested for save.TextModel
屬性詳細資訊

editorData

屬性
editorData:EditorResult

語言版本: ActionScript 3.0
產品版本: Asset Composer Building Block 9.5
執行階段版本: AIR (unsupported), Flash Player 9, Flash Player 10

Represents that data held by the Rich Text Editor.

此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 editorDataChange 事件。



實作
    public function get editorData():EditorResult
    public function set editorData(value:EditorResult):void

isDDReferenced

屬性 
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 text has been referred in any of the assignments.

此屬性可以做為資料繫結的來源。一旦修改此屬性,將傳送 isDDReferencedChange 事件。



實作
    public function get isDDReferenced():Boolean
    public function set isDDReferenced(value:Boolean):void

service

屬性 
public static var service:IModuleService

語言版本: ActionScript 3.0
產品版本: Asset Composer Building Block 9.5
執行階段版本: AIR (unsupported), Flash Player 9, Flash Player 10

The module service instance that is used for saving/retrieving the module on the server. This service is internally invoked by this class for performing CRUD operations.

方法詳細資訊

copy

()方法
public function copy():com.adobe.icc.editors.model:TextModel

語言版本: 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.

傳回值
com.adobe.icc.editors.model:TextModel — A copy of current domain object.

createFromVO

()方法 
public static function createFromVO(textVO:com.adobe.consulting.pst.vo:TBX, fetchFromServer:Boolean = true):com.adobe.icc.editors.model:TextModel

語言版本: 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.

參數

textVO:com.adobe.consulting.pst.vo:TBX — The value object of the type TBX
 
fetchFromServer:Boolean (default = true) — Flag to indicate if the complete value object should be obtained from the server

傳回值
com.adobe.icc.editors.model:TextModel — The Text domain object corresponding the passed Text value object.

fetchComplete

()方法 
override public function fetchComplete():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.

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.

setModuleService

()方法 
public static function setModuleService(value:IModuleService):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 module service. By default, the class ModuleServiceDelegate is used as the infrastructure service.

參數

value:IModuleService — An implementation for IModuleService.

事件詳細資訊

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 text is successfully saved.

The AssetEvent.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 text.

The AssetEvent.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 text 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 AssetEvent.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".





[ X ]為什麼顯示英文?
「ActionScript 3.0 參考」的內容是以英文顯示

並非所有「ActionScript 3.0 參考」的內容都翻譯為所有語言。當語言元素未翻譯時,就會以英文顯示。例如,ga.controls.HelpBox 類別並沒有翻譯為任何語言。因此在參考的繁體中文版本中,ga.controls.HelpBox 類別就會以英文顯示。