ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
com.adobe.icc.editors.model 

TextModel  - AS3 Asset Composer

Paketcom.adobe.icc.editors.model
Klassepublic class TextModel
VererbungTextModel Inheritance ModuleModel Inheritance AssetModel Inheritance EventDispatcher Inheritance Object

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 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
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
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
[statisch] 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
[schreibgeschützt] 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
Geschützte Eigenschaften
 EigenschaftDefiniert von
 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
Öffentliche Methoden
 MethodeDefiniert von
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.
EventDispatcher
  
Creates a copy of the domain object.
TextModel
 Inherited
[statisch] Fetches a module by the given id and constructs the domain module object on top of it.
ModuleModel
  
[statisch] Creates the domain object from the corresponding value object.
TextModel
 Inherited
Sendet ein Ereignis in den Ereignisablauf.
EventDispatcher
  
[override] Fetches the complete value object via remoting call.
TextModel
 Inherited
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.
EventDispatcher
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Indicates if the underlying value object is shallow.
ModuleModel
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Entfernt einen Listener aus dem EventDispatcher-Objekt.
EventDispatcher
  
[override] 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
[statisch] This method lets you inject a custom implementation of the infrastructure data dictionary service.
ModuleModel
  
[statisch] This method lets you inject a custom implementation of the infrastructure module service.
TextModel
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Runs the client validations and raises events of the type AssetValidationEvent for notifying validation result.
ModuleModel
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
 Inherited
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.
EventDispatcher
Geschützte Methoden
 MethodeDefiniert von
 Inherited
Fetches the data dictionary corresponding to the name specified.
ModuleModel
Ereignisse
 Ereignis Übersicht Definiert von
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.EventDispatcher
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.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
Eigenschaftendetails

editorData

Eigenschaft
editorData:EditorResult

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: AIR (unsupported), Flash Player 9, Flash Player 10

Represents that data held by the Rich Text Editor.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das editorDataChange -Ereignis ausgelöst.



Implementierung
    public function get editorData():EditorResult
    public function set editorData(value:EditorResult):void

isDDReferenced

Eigenschaft 
isDDReferenced:Boolean

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das isDDReferencedChange -Ereignis ausgelöst.



Implementierung
    public function get isDDReferenced():Boolean
    public function set isDDReferenced(value:Boolean):void

service

Eigenschaft 
public static var service:IModuleService

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.

Methodendetails

copy

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

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.

Rückgabewerte
com.adobe.icc.editors.model:TextModel — A copy of current domain object.

createFromVO

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

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.

Parameter

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

Rückgabewerte
com.adobe.icc.editors.model:TextModel — The Text domain object corresponding the passed Text value object.

fetchComplete

()Methode 
override public function fetchComplete():void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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

()Methode 
override public function save():void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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

()Methode 
public static function setModuleService(value:IModuleService):void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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.

Parameter

value:IModuleService — An implementation for IModuleService.

Ereignisdetails

fetchComplete

Ereignis
Ereignisobjekttyp: flash.events.Event
Eigenschaft Event.type = flash.events.Event

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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

Ereignis  
Ereignisobjekttyp: com.adobe.icc.editors.events.AssetEvent
Eigenschaft AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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

Ereignis  
Ereignisobjekttyp: com.adobe.icc.editors.events.AssetEvent
Eigenschaft AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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

Ereignis  
Ereignisobjekttyp: com.adobe.icc.editors.events.AssetEvent
Eigenschaft AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVING

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Composer“ 9.5
Laufzeitversionen: 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 ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.