ChangeWatcher

Package	mx.binding.utils
Classe	public class ChangeWatcher
Héritage	ChangeWatcher Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

La classe ChangeWatcher définit des méthodes d’utilitaire que vous pouvez utiliser avec les propriétés Flex liables. Ces méthodes permettent de définir un gestionnaire d’événements exécuté chaque fois qu’une propriété liable est mise à jour.

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		useWeakReference : Boolean Détermine si la référence au gestionnaire est forte ou faible.	ChangeWatcher

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		ChangeWatcher(access:Object, handler:Function, commitOnly:Boolean = false, next:ChangeWatcher = null) Constructeur.	ChangeWatcher
		canWatch(host:Object, name:String, commitOnly:Boolean = false):Boolean [statique] Permet de déterminer si l’hôte expose un événement de liaison de données sur la propriété.	ChangeWatcher
		getEvents(host:Object, name:String, commitOnly:Boolean = false):Object [statique] Renvoie tous les événements de liaison pour une propriété liable dans l’objet hôte.	ChangeWatcher
		getValue():Object Extrait la valeur actuelle de la propriété ou chaîne de propriétés surveillée ou null si l’objet hôte est nul.	ChangeWatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		isWatching():Boolean Renvoie true si chaque surveillant dans la chaîne est rattaché à au moins un événement change.	ChangeWatcher
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		reset(newHost:Object):void Réinitialise cette instance ChangeWatcher pour utiliser un nouvel objet hôte.	ChangeWatcher
		setHandler(handler:Function):void Définit la fonction du gestionnaire.	ChangeWatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		unwatch():void Détache cette instance ChangeWatcher et sa fonction de gestionnaire de l’hôte actuel.	ChangeWatcher
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		watch(host:Object, chain:Object, handler:Function, commitOnly:Boolean = false, useWeakReference:Boolean = false):ChangeWatcher [statique] Crée et démarre une instance ChangeWatcher.	ChangeWatcher

Détails de la propriété

useWeakReference

propriété

public var useWeakReference:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Détermine si la référence au gestionnaire handler est forte ou faible. Une référence forte (valeur par défaut) empêche le nettoyage du gestionnaire handler. Cela n’est pas le cas avec une référence faible.

La valeur par défaut est false.

Détails du constructeur

()

Constructeur

public function ChangeWatcher(access:Object, handler:Function, commitOnly:Boolean = false, next:ChangeWatcher = null)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur. Non destiné à une utilisation publique. Cette méthode n’est appelée qu’à partir de la méthode watch(). Voir la méthode watch() pour connaître l’utilisation du paramètre.

Paramètres

	`access:Object`

	`handler:Function`

	`commitOnly:Boolean` (default = `false`)

	`next:ChangeWatcher` (default = `null`)

Détails de la méthode

canWatch

()

méthode

public static function canWatch(host:Object, name:String, commitOnly:Boolean = false):Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Permet de déterminer si l’hôte expose un événement de liaison de données sur la propriété.

REMARQUE : les chaînes de propriétés ne sont pas prises en charge par la méthode canWatch(). Elles sont prises en charge par la méthodewatch().

Paramètres

	`host:Object` — Hôte de la propriété. Pour plus d’informations, voir la méthode `watch()`.

	`name:String` — Nom de la propriété. Pour plus d’informations, voir la méthode `watch()`.

	`commitOnly:Boolean` (default = `false`) — Défini sur `true` si le gestionnaire ne doit être appelé que lors d’événements change validants. Pour plus d’informations, voir la méthode `watch()`.

Valeur renvoyée

Boolean — true si host expose des événements de modification sur name.

getEvents

()

méthode

public static function getEvents(host:Object, name:String, commitOnly:Boolean = false):Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Renvoie tous les événements de liaison pour une propriété liable dans l’objet hôte.

Paramètres

	`host:Object` — Hôte de la propriété. Pour plus d’informations, voir la méthode `watch()`.

	`name:String` — Nom de la propriété ou chaîne de propriétés. Pour plus d’informations, voir la méthode `watch()`.

	`commitOnly:Boolean` (default = `false`) — Contrôle l’inclusion d’événements change non validants dans la valeur renvoyée.

Valeur renvoyée

Object — Objet au format { eventName: isCommitting, } contenant tous les événements change de la propriété.

getValue

()

méthode

public function getValue():Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Extrait la valeur actuelle de la propriété ou chaîne de propriétés surveillée ou null si l’objet hôte est nul. Par exemple :

      watch(obj, ["a","b","c"], ...).getValue() === obj.a.b.c

Valeur renvoyée

Object — Valeur actuelle de la propriété ou chaîne de propriétés surveillée.

isWatching

()

méthode

public function isWatching():Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Renvoie true si chaque surveillant dans la chaîne est rattaché à au moins un événement change. Notez que la méthode isWatching() varie selon l’hôte, car différents hôtes peuvent exposer différents événements change pour la propriété choisie du surveillant.

Valeur renvoyée

Boolean — true si chaque surveillant dans la chaîne est rattaché à au moins un événement change.

reset

()

méthode

public function reset(newHost:Object):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Réinitialise cette instance ChangeWatcher pour utiliser un nouvel objet hôte. Vous pouvez appeler cette méthode pour réutiliser une instance de surveillant sur un hôte différent.

Paramètres

newHost:Object — Nouvel hôte de la propriété. Pour plus d’informations, voir la méthode watch().

setHandler

()

méthode

public function setHandler(handler:Function):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Définit la fonction du gestionnaire.

Paramètres

handler:Function — Fonction du gestionnaire. L’argument ne doit pas être nul.

unwatch

()

méthode

public function unwatch():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Détache cette instance ChangeWatcher et sa fonction de gestionnaire de l’hôte actuel. Vous pouvez utiliser la méthode reset() pour réattacher l’instance ChangeWatcher ou surveiller la même propriété ou chaîne sur un objet hôte différent.

watch

()

méthode

 public static function watch(host:Object, chain:Object, handler:Function, commitOnly:Boolean = false, useWeakReference:Boolean = false):ChangeWatcher

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Crée et démarre une instance ChangeWatcher. Une instance ChangeWatcher unique peut surveiller une propriété ou chaîne de propriétés. Une chaîne de propriétés est une séquence de propriétés accessible à partir d’un objet hôte. Par exemple, l’expression obj.a.b.c contient la chaîne de propriétés (a, b, c).

Paramètres

	`host:Object` — Objet qui héberge la propriété ou chaîne de propriétés à surveiller. Vous pouvez utiliser la méthode `reset()` pour changer la valeur de l’argument `host` une fois l’instance ChangeWatcher créée. L’hôte `host` conserve une liste de gestionnaires `handler` à appeler lorsque `prop` change.

	`chain:Object` — Valeur spécifiant la propriété ou chaîne à surveiller. Les valeurs légales sont les suivantes : Chaîne contenant le nom d’une propriété liable publique de l’objet hôte. Objet au format : `{ name: nom de propriété, getter: function(host) { return host[name] } }`. L’objet contient le nom d’une propriété liable publique et une fonction servant d’accesseur de lecture pour cette propriété. Tableau non vide contenant une combinaison des deux premières options. Cela représente une chaîne de propriétés liables accessibles à partir de l’hôte. Par exemple, pour surveiller la propriété `host.a.b.c`, appelez la méthode comme suit : `watch(host, ["a","b","c"], ...)`. Remarque : la ou les propriétés nommées dans l’argument `chain` doivent être publiques, car la méthode `describeType()` supprime toutes les informations concernant les propriétés non publiques, y compris les métadonnées de capacité de liaison que ChangeWatcher analyse afin de rechercher les événements change exposés pour une propriété donnée. Cependant, la fonction d’accesseur de lecture fournie lors de l’utilisation du format d’argument `{ name, getter }` décrit ci-dessus peut être utilisée pour associer une valeur calculée arbitraire à la propriété (publique) nommée.

	`handler:Function` — Fonction de gestionnaire d’événements appelée lorsque la valeur de la propriété surveillée (ou d’une propriété dans une chaîne surveillée) est modifiée. La modification est signalée lorsqu’un objet hôte dans la chaîne du surveillant distribue l’événement ayant été spécifié dans la balise de métadonnées `[Bindable]` de cet objet hôte pour la propriété surveillée correspondante. L’événement par défaut est nommé `propertyChange`. L’objet d’événement distribué par la propriété liable est transmis à cette fonction de gestionnaire sans modification. Par défaut, Flex distribue un objet d’événement de type PropertyChangeEvent. Cependant, vous pouvez définir votre propre type d’événement lorsque vous utilisez la balise de métadonnées `[Bindable]` pour définir une propriété liable.

	`commitOnly:Boolean` (default = `false`) — Défini sur `true` si le gestionnaire ne doit être appelé que lors d’événements change validants ; défini sur `false` si le gestionnaire doit être appelé lors d’événements change validants et non validants. Remarque : la présence d’événements change non validants pour une propriété est indiquée par la balise de métadonnées `[NonCommittingChangeEvent(<nom de l’événement>)]`. Ces balises sont généralement utilisées pour indiquer des modifications de valeur subtiles, telles que des modifications dans un champ de texte avant confirmation.

	`useWeakReference:Boolean` (default = `false`) — (Valeur par défaut = false) Détermine si la référence au gestionnaire `handler` est forte ou faible. Une référence forte (valeur par défaut) empêche le nettoyage du gestionnaire `handler`. Cela n’est pas le cas avec une référence faible.

Valeur renvoyée

ChangeWatcher — Instance ChangeWatcher, si au moins un nom de propriété a été spécifié au niveau de l’argument chain ; dans le cas contraire, null. Notez qu’il n’est pas garanti que le surveillant renvoyé a découvert et s’est rattaché avec succès aux événements change, car il se peut qu’aucun n’ait été exposé par l’hôte sur la propriété ou chaîne donnée. Vous pouvez utiliser la méthode isWatching() pour déterminer l’état du surveillant.

Eléments de l’API associés

mx.events.PropertyChangeEvent

Informations juridiques | Politique de confidentialité en ligne

ChangeWatcher - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.binding.utils

useWeakReference

ChangeWatcher

canWatch

getEvents

getValue

isWatching

reset

setHandler

unwatch

watch