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 : AIR 30.0 et versions antérieures, Flash Player 30.0 et versions antérieures, Flash Lite 4
Flex 4.6 et versions antérieures, Flash Pro CS6 et versions antérieures
Masquer les filtres
mx.utils 

ObjectProxy  - AS3 Flex

Packagemx.utils
Classepublic dynamic class ObjectProxy
HéritageObjectProxy Inheritance Proxy
Implémente IExternalizable, IPropertyChangeNotifier
Sous-classes DataItem, ManagedObjectProxy

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Cette classe permet de suivre les modifications apportées à un élément géré par ce proxy. Un certain nombre d’objets peuvent écouter les modifications apportées à cet objet, à l’aide de la méthode addEventListener().



Propriétés publiques
 PropriétéDéfini par
  uid : String
ID unique de cet objet.
ObjectProxy
Propriétés protégées
 PropriétéDéfini par
  dispatcher : EventDispatcher
Référence à la classe EventDispatcher pour ce proxy.
ObjectProxy
  notifiers : Object
Une table de hachage des notifications de modification de propriété que ce proxy écoute est modifiée. La clé de la carte est le nom de la propriété.
ObjectProxy
  object : Object
[lecture seule] Objet en cours de traitement par proxy.
ObjectProxy
  propertyList : Array
Contient une liste de tous les noms de propriété de l’objet traité par proxy.
ObjectProxy
  proxyClass : Class
Indique le type de proxy à créer lors du traitement par proxy de propriétés complexes.
ObjectProxy
  type : QName
Le nom de type qualifié associé à cet objet.
ObjectProxy
Méthodes publiques
 MéthodeDéfini par
  
ObjectProxy(item:Object = null, uid:String = null, proxyDepth:int = -1)
Initialise ce proxy avec l’objet spécifié, l’id et la profondeur du proxy.
ObjectProxy
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement afin que l’écouteur soit averti d’un événement.
ObjectProxy
  
Distribue un événement dans le flux d’événements.
ObjectProxy
  
Vérifie si des écouteurs d’événement sont enregistrés pour un type d’événement spécifique.
ObjectProxy
  
Appelé lorsqu’une propriété complexe est mise à jour.
ObjectProxy
  
Etant donné que Flex utilise uniquement la classe ObjectProxy pour renvoyer des objets anonymes, l’instance de serveur flex.messaging.io.ObjectProxy se sérialise sous forme de carte qui est renvoyée en tant qu’objet ActionScript ordinaire.
ObjectProxy
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur d’événement.
ObjectProxy
  
Vérifie si un écouteur d’événement est enregistré auprès de cet objet ou de ses ancêtres pour le type d’événement spécifié.
ObjectProxy
  
Etant donné que Flex sérialise uniquement l’objet ActionScript intérieur qu’il enveloppe, le serveur flex.messaging.io.ObjectProxy se remplit avec le contenu de cet objet anonyme et s’affiche sous forme de carte.
ObjectProxy
Méthodes protégées
 MéthodeDéfini par
  
callProperty(name:*, ... rest):*
[override] Renvoie la valeur de la méthode de l’objet traité par proxy avec le nom spécifié.
ObjectProxy
  
[override] Supprime la propriété spécifiée de l’objet traité par proxy et envoie une notification de la suppression au gestionnaire.
ObjectProxy
  
getComplexProperty(name:*, value:*):*
Fournit un endroit permettant aux sous-classes de modifier la manière dont une propriété complexe devant être traitée par proxy ou enchaînée à des fins de remontée d’événements est gérée.
ObjectProxy
  
[override] Renvoie la valeur de propriété spécifiée de l’objet traité par proxy.
ObjectProxy
  
setProperty(name:*, value:*):void
[override] Met à jour la propriété spécifiée de l’objet traité par proxy et envoie une notification de la mise à jour au gestionnaire.
ObjectProxy
  
Cette méthode crée un tableau de tous les noms de propriété de l’objet traité par proxy.
ObjectProxy
Détails de la propriété

dispatcher

propriété
protected var dispatcher:EventDispatcher

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Référence à la classe EventDispatcher pour ce proxy.

notifiers

propriété 
protected var notifiers:Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Une table de hachage des notifications de modification de propriété que ce proxy écoute est modifiée. La clé de la carte est le nom de la propriété.

object

propriété 
object:Object  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Objet en cours de traitement par proxy.



Implémentation
    object_proxy function get object():Object

propertyList

propriété 
protected var propertyList:Array

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Contient une liste de tous les noms de propriété de l’objet traité par proxy. Descendants nécessaire pour remplir cette liste en remplaçant la méthode setupPropertyList().

proxyClass

propriété 
protected var proxyClass:Class

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Indique le type de proxy à créer lors du traitement par proxy de propriétés complexes. Les sous-classes doivent affecter cette valeur correctement.

type

propriété 
type:QName

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Le nom de type qualifié associé à cet objet.



Implémentation
    object_proxy function get type():QName
    object_proxy function set type(value:QName):void

uid

propriété 
uid:String

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

ID unique de cet objet.



Implémentation
    public function get uid():String
    public function set uid(value:String):void
Détails du constructeur

ObjectProxy

()Constructeur
public function ObjectProxy(item:Object = null, uid:String = null, proxyDepth:int = -1)

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Initialise ce proxy avec l’objet spécifié, l’id et profondeur du proxy.

Paramètres
item:Object (default = null) — Objet pour lequel définir un proxy. Si aucun élément n’est spécifié, un objet anonyme est créé et affecté.
 
uid:String (default = null) — Chaîne contenant l’ID unique de cette instance d’objet. Ce paramètre est requis pour la conformité avec l’interface IPropertyChangeNotifier, car chaque objet doit fournir un moyen unique permettant de l’identifier. Si aucune valeur n’est spécifiée, un ID aléatoire est affecté.
 
proxyDepth:int (default = -1) — Nombre entier indiquant le nombre de niveaux d’un objet graphique complexe pour lesquels créer un proxy lors de l’accès à la propriété. La valeur par défaut est -1, ce qui signifie « proxy à une profondeur infinie ».

Exemple
Comment utiliser cet exemple
      import mx.events.PropertyChangeEvent;
      import mx.utils.ObjectUtil;
      import mx.utils.ObjectProxy;
      import mx.utils.StringUtil;
     
      var a:Object = { name: "Tyler", age: 5, ssnum: "555-55-5555" };
      var p:ObjectProxy = new ObjectProxy(a);
      p.addEventListener(PropertyChangeEvent.PROPERTY_CHANGE, updateHandler);
      p.name = "Jacey";
      p.age = 2;
      delete p.ssnum;
     
      // handler function
      function updateHandler(event:PropertyChangeEvent):void
      {
          trace(StringUtil.substitute("updateHandler('{0}', {1}, {2}, {3}, '{4}')",
                                         event.kind,
                                         event.property,
                                         event.oldValue,
                                         event.newValue,
                                         event.target.uid));
      }
     
      // trace output
      updateHandler('opUpdate', name, Jacey, '698AF8CB-B3D9-21A3-1AFFDGHT89075CD2')
      updateHandler('opUpdate', age, 2, '698AF8CB-B3D9-21A3-1AFFDGHT89075CD2')
      updateHandler('opDelete', ssnum, null, '698AF8CB-B3D9-21A3-1AFFDGHT89075CD2')
      
Détails de la méthode

addEventListener

()méthode
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Enregistre un objet écouteur d’événement afin que l’écouteur soit averti d’un événement. Pour plus d’informations, notamment une description des paramètres, voir la méthode addEventListener() de la classe flash.events.EventDispatcher.

Paramètres

type:String — Type d’événement.
 
listener:Function — Fonction d’auditeur qui traite l’événement. Cette fonction doit accepter un objet Event comme paramètre unique et ne rien renvoyer.
 
useCapture:Boolean (default = false) — Détermine si l’écouteur est actif pendant la phase de capture ou pendant les phases cible et de propagation vers le haut. Si la propriété useCapture est définie sur true, l’écouteur traite l’événement uniquement pendant la phase de capture et non pendant les phases cible et de propagation. Si la propriété useCapture est définie sur false, l’écouteur traite l’événement uniquement pendant les phases cible et de propagation. Pour écouter l’événement dans les trois phases, appelez addEventListener à deux reprises, une première fois en définissant useCapture sur true, puis une nouvelle fois en définissant useCapture sur false.
 
priority:int (default = 0) — Niveau de priorité de l’écouteur d’événements.
 
useWeakReference:Boolean (default = false) — Détermine si la référence à l’écouteur est forte ou faible. Une référence forte (valeur par défaut) empêche le nettoyage de votre écouteur, Cela n’est pas le cas avec une référence faible.

Eléments de l’API associés

callProperty

()méthode 
override flash_proxy function callProperty(name:*, ... rest):*

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Renvoie la valeur de la méthode de l’objet traité par proxy avec le nom spécifié.

Paramètres

name:* — Nom de la méthode invoquée.
 
... rest — Tableau qui spécifie les arguments à la méthode appelée.

Valeur renvoyée
* — Valeur renvoyée par la méthode appelée.

deleteProperty

()méthode 
override flash_proxy function deleteProperty(name:*):Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Supprime la propriété spécifiée de l’objet traité par proxy et envoie une notification de la suppression au gestionnaire.

Paramètres

name:* — Il s’agit généralement d’une chaîne contenant le nom de la propriété ou éventuellement d’une valeur QName dont le nom de la propriété peut-être retrouvé en examinant la propriété localName.

Valeur renvoyée
Boolean — Valeur booléenne indiquant si la propriété a été supprimée.

dispatchEvent

()méthode 
public function dispatchEvent(event:Event):Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Distribue un événement dans le flux d’événements. Pour plus d’informations, voir la classe flash.events.EventDispatcher.

Paramètres

event:Event — Objet Event qui est distribué dans le flux d’événements. Si l’événement est redistribué, un clone est automatiquement créé. Après la distribution d’un événement, il est impossible de modifier sa propriété target. Pour que la redistribution fonctionne, vous devez donc créer une copie de l’événement.

Valeur renvoyée
Boolean — Renvoie la valeur true si l’événement a été distribué. La valeur false indique un échec ou que preventDefault() a été appelé sur l’événement.

Eléments de l’API associés

getComplexProperty

()méthode 
object_proxy function getComplexProperty(name:*, value:*):*

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Fournit un endroit permettant aux sous-classes de modifier la manière dont une propriété complexe devant être traitée par proxy ou enchaînée à des fins de remontée d’événements est gérée.

Paramètres

name:* — Il s’agit généralement d’une chaîne contenant le nom de la propriété ou éventuellement d’une valeur QName dont le nom de la propriété peut-être retrouvé en examinant la propriété localName.
 
value:* — Valeur de la propriété.

Valeur renvoyée
* — Valeur de la propriété ou instance de la classe ObjectProxy.

getProperty

()méthode 
override flash_proxy function getProperty(name:*):*

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Renvoie la valeur de propriété spécifiée de l’objet traité par proxy.

Paramètres

name:* — Il s’agit généralement d’une chaîne contenant le nom de la propriété ou éventuellement d’une valeur QName dont le nom de la propriété peut-être retrouvé en examinant la propriété localName.

Valeur renvoyée
* — Valeur de la propriété. Dans certains cas, cette valeur peut être une instance de ObjectProxy.

hasEventListener

()méthode 
public function hasEventListener(type:String):Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Vérifie si des écouteurs d’événement sont enregistrés pour un type d’événement spécifique. Vous pouvez ainsi déterminer précisément où un objet a modifié la gestion d’un type d’événement dans la hiérarchie du flux d’événements. Pour plus d’informations, voir la classe flash.events.EventDispatcher.

Paramètres

type:String — Type d’événement

Valeur renvoyée
Boolean — Renvoie la valeur true si un écouteur du type spécifié est enregistré. La valeur false est renvoyée dans tous les autres cas.

Eléments de l’API associés

propertyChangeHandler

()méthode 
public function propertyChangeHandler(event:PropertyChangeEvent):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Appelé lorsqu’une propriété complexe est mise à jour.

Paramètres

event:PropertyChangeEvent — Objet d’événement qui a été modifié.

readExternal

()méthode 
public function readExternal(input:IDataInput):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Etant donné que Flex utilise uniquement la classe ObjectProxy pour renvoyer des objets anonymes, l’instance de serveur flex.messaging.io.ObjectProxy se sérialise sous forme de carte qui est renvoyée en tant qu’objet ActionScript ordinaire. Vous pouvez ensuite définir les propriétés de l’objet object_proxy sur cette valeur.

Paramètres

input:IDataInput — Objet source à partir duquel la classe ObjectProxy est désérialisée.

removeEventListener

()méthode 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Supprime un écouteur d’événement. Si aucun écouteur correspondant n’est enregistré auprès de l’objet EventDispatcher, l’appel de cette méthode n’a aucun effet. Pour plus d’informations, voir la classe flash.events.EventDispatcher.

Paramètres

type:String — Type d’événement.
 
listener:Function — Objet écouteur à supprimer.
 
useCapture:Boolean (default = false) — Détermine si l’écouteur a été enregistré pendant la phase de capture ou pendant les phases cible et de propagation vers le haut. Si l’écouteur a été enregistré pendant la phase de capture et pendant les phases cible et de propagation vers le haut (bubbling), il est nécessaire d’appeler removeEventListener() à deux reprises pour le supprimer : une première fois en définissant useCapture sur true, puis une seconde fois avecuseCapture défini sur false.

Eléments de l’API associés

setProperty

()méthode 
override flash_proxy function setProperty(name:*, value:*):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Met à jour la propriété spécifiée de l’objet traité par proxy et envoie une notification de la mise à jour au gestionnaire.

Paramètres

name:* — Objet contenant le nom de la propriété à mettre à jour sur l’objet mis en proxy.
 
value:* — Valeur à définir sur l’objet mis en proxy.

setupPropertyList

()méthode 
protected function setupPropertyList():void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Cette méthode crée un tableau de tous les noms de propriété de l’objet traité par proxy. Les descendants doivent remplacer cette méthode s’ils souhaitent ajouter plusieurs propriétés à la liste. Veillez à appeler super.setupPropertyList avant de procéder à des modifications de la propriété propertyList.

willTrigger

()méthode 
public function willTrigger(type:String):Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Vérifie si un écouteur d’événement est enregistré auprès de cet objet ou de ses ancêtres pour le type d’événement spécifié. Cette méthode renvoie true si un écouteur d’événement est déclenché pendant toute phase du flux d’événements lorsqu’un événement du type spécifié est distribué à cet objet ou à l’un de ses descendants. Pour plus d’informations, voir la classe flash.events.EventDispatcher.

Paramètres

type:String — Type d’événement.

Valeur renvoyée
Boolean — Renvoie la valeur true si un écouteur du type spécifié est déclenché. La valeur false est renvoyée dans tous les autres cas.

Eléments de l’API associés

writeExternal

()méthode 
public function writeExternal(output:IDataOutput):void

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Etant donné que Flex sérialise uniquement l’objet ActionScript intérieur qu’il enveloppe, le serveur flex.messaging.io.ObjectProxy se remplit avec le contenu de cet objet anonyme et s’affiche sous forme de carte.

Paramètres

output:IDataOutput — Objet source à partir duquel la classe ObjectProxy est désérialisée.





[ 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.