Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
com.adobe.icc.editors.model 

ImageModel  - AS3 Asset Composer

Packagecom.adobe.icc.editors.model
Classepublic class ImageModel
HéritageImageModel Inheritance ModuleModel Inheritance AssetModel Inheritance EventDispatcher Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

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



Propriétés publiques
 PropriétéDéfini par
 InheritedactiveEndDate : Date
The activeEndDate of the underlying value object.
AssetModel
 InheritedactiveStartDate : Date
The activeStartDate date of the underlying value object.
AssetModel
  caption : String
The caption for this image.
ImageModel
 Inheritedcategory : Category
The Category of the underlying value object.
AssetModel
 Inheritedcomment : String
The comment of the underlying value object.
AssetModel
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
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
 InheritedextendedProperties : Object
The extended properties of the underlying value object.
AssetModel
  file : FileModel
The file domain object associated with this image.
ImageModel
 Inheritedid : String
The GUID of the underlying value object.
AssetModel
 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
[statique] The module service instance that is used for saving/retrieving the module on the server.
ImageModel
 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
[lecture seule] 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
Propriétés protégées
 PropriétéDéfini par
 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
Méthodes publiques
 MéthodeDéfini par
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.
EventDispatcher
  
Creates a copy of the domain object.
ImageModel
 Inherited
[statique] Fetches a module by the given id and constructs the domain module object on top of it.
ModuleModel
  
createFromVO(imageVO:ImageModule, fetchFromServer:Boolean = true):ImageModel
[statique] Creates the domain object from the corresponding value object.
ImageModel
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
  
[override] Fetches the complete value object via remoting call.
ImageModel
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
  
Indicates whether the data dictionary defined for this image has been referred in any of the assignments.
ImageModel
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indicates if the underlying value object is shallow.
ModuleModel
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
  
[override] Saves the underlying value object on the server.
ImageModel
 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
[statique] This method lets you inject a custom implementation of the infrastructure data dictionary service.
ModuleModel
  
[statique] This method lets you inject a custom implementation of the infrastructure module service.
ImageModel
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Runs the client validations and raises events of the type AssetValidationEvent for notifying validation result.
ModuleModel
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.
EventDispatcher
Méthodes protégées
 MéthodeDéfini par
 Inherited
Fetches the data dictionary corresponding to the name specified.
ModuleModel
Evénements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
  Dispatched when this Asset is completely fetched from the server.ImageModel
  Dispatched when the image is successfully saved.ImageModel
  Dispatched when a fault occurs while saving the image.ImageModel
  Dispatched when the current image is requested for save.ImageModel
Détails de la propriété

caption

propriété
caption:String

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The caption for this image.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement valueObjectChange .



Implémentation
    public function get caption():String
    public function set caption(value:String):void

file

propriété 
file:FileModel

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

The file domain object associated with this image.

The file domain object is a representation of the image file that is uploaded by the user at the time of creation or updating of this image.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement fileChange .



Implémentation
    public function get file():FileModel
    public function set file(value:FileModel):void

service

propriété 
public static var service:IModuleService

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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.

Détails de la méthode

copy

()méthode
public function copy():ImageModel

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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.

Valeur renvoyée
ImageModel — A copy of current domain object.

createFromVO

()méthode 
public static function createFromVO(imageVO:ImageModule, fetchFromServer:Boolean = true):ImageModel

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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.

Paramètres

imageVO:ImageModule — The value object of the type Image
 
fetchFromServer:Boolean (default = true) — Flag to indicate if the complete value object should be obtained from the server

Valeur renvoyée
ImageModel — The Image domain object corresponding the passed Image value object.

fetchComplete

()méthode 
override public function fetchComplete():void

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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.

isDDReferenced

()méthode 
public function isDDReferenced():Boolean

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Indicates whether the data dictionary defined for this image has been referred in any of the assignments.

Valeur renvoyée
Boolean — true, if the data dictionary is referred. false, otherwise.

save

()méthode 
override public function save():void

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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

()méthode 
public static function setModuleService(value:IModuleService):void

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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.

Paramètres

value:IModuleService — An implementation for IModuleService.

Détails de l’événement

fetchComplete

Evénement
Type d’objet d’événement: flash.events.Event
propriété Event.type = flash.events.Event

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: 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

Evénement  
Type d’objet d’événement: com.adobe.icc.editors.events.AssetEvent
propriété AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when the image 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

Evénement  
Type d’objet d’événement: com.adobe.icc.editors.events.AssetEvent
propriété AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when a fault occurs while saving the image.

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

Evénement  
Type d’objet d’événement: com.adobe.icc.editors.events.AssetEvent
propriété AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVING

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Composer 9.5
Versions du moteur d’exécution: AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when the current image 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 ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.