ToolTipManager - Guide de référence de l’API Adobe ActionScript® 3 (AS3 Flex)

Package	mx.managers
Classe	public class ToolTipManager
Héritage	ToolTipManager EventDispatcher 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 ToolTipManager vous permet de définir une fonctionnalité de base sur les infos-bulles et les conseils d’erreur, comme le délai d’affichage et la désactivation des infos-bulles.

Eléments de l’API associés

mx.controls.ToolTip
mx.validators.Validator

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
		currentTarget : DisplayObject [statique] Objet UIComponent qui affiche actuellement une info-bulle, ou valeur null si aucun ne le fait.	ToolTipManager
		currentToolTip : mx.core:IToolTip [statique] Objet ToolTip actuellement visible, ou valeur null si aucun n’est affiché.	ToolTipManager
		enabled : Boolean [statique] Si la valeur est true, la classe ToolTipManager affiche automatiquement les infos-bulles lorsque l’utilisateur déplace le pointeur de la souris sur les composants.	ToolTipManager
		hideDelay : Number [statique] Temps, en millisecondes, que doit attendre Flex avant de masquer l’info-bulle après son apparition.	ToolTipManager
		hideEffect : IAbstractEffect [statique] Effet qui est lu lorsqu’une info-bulle est masquée ou valeur null si l’info-bulle doit disparaître sans effet.	ToolTipManager
		scrubDelay : Number [statique] Temps, en millisecondes, qu’un utilisateur peut prendre lorsqu’il déplace la souris entre les contrôles avant que Flex n’attende à nouveau la durée du contrôle showDelay pour afficher une info-bulle.	ToolTipManager
		showDelay : Number [statique] Temps, en millisecondes, que Flex attend avant d’affiche la zone d’info-bulle une fois que l’utilisateur a déplacé la souris sur un composant doté d’une info-bulle.	ToolTipManager
		showEffect : IAbstractEffect [statique] Effet qui est lu lorsqu’une info-bulle est affichée ou valeur null si l’info-bulle doit apparaître sans effet.	ToolTipManager
		toolTipClass : Class [statique] Classe à utiliser pour créer les infos-bulles.	ToolTipManager

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		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
		createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip [statique] Crée une instance de la classe ToolTip avec le texte spécifié et l’affiche à l’emplacement indiqué dans les coordonnées de la scène.	ToolTipManager
		destroyToolTip(toolTip:mx.core:IToolTip):void [statique] Supprime une info-bulle spécifiée qui a été créée par la méthode createToolTip().	ToolTipManager
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		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
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean 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

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Evénement		Synthèse	Défini par
		activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
		deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher

Détails de la propriété

currentTarget

propriété

currentTarget:DisplayObject

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Objet UIComponent qui affiche actuellement une info-bulle, ou valeur null si aucun ne le fait.

Implémentation
public static function get currentTarget():DisplayObject
public static function set currentTarget(value:DisplayObject):void

currentToolTip

propriété

currentToolTip:mx.core:IToolTip

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Objet ToolTip actuellement visible, ou valeur null si aucun n’est affiché.

Implémentation
public static function get currentToolTip():mx.core:IToolTip
public static function set currentToolTip(value:mx.core:IToolTip):void

enabled

propriété

enabled:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Si la valeur est true, la classe ToolTipManager affiche automatiquement les infos-bulles lorsque l’utilisateur déplace le pointeur de la souris sur les composants. Si la valeur est false, aucune info-bulle n’est affichée.

La valeur par défaut est true.

Implémentation
public static function get enabled():Boolean
public static function set enabled(value:Boolean):void

hideDelay

propriété

hideDelay:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Temps, en millisecondes, que doit attendre Flex avant de masquer l’info-bulle après son apparition. Une fois que Flex a masqué une info-bulle, l’utilisateur doit éloigner la souris du composant, puis la repasser dessus pour voir à nouveau l’info-bulle. Si vous définissez hideDelay sur Infinity, Flex ne masque pas l’info-bulle tant que l’utilisateur ne déclenche pas un événement, par exemple s’il éloigne la souris du composant.

La valeur par défaut est 10000.

Implémentation
public static function get hideDelay():Number
public static function set hideDelay(value:Number):void

hideEffect

propriété

hideEffect:IAbstractEffect

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Effet qui est lu lorsqu’une info-bulle est masquée ou valeur null si l’info-bulle doit disparaître sans effet.

La valeur par défaut est null.

Implémentation
public static function get hideEffect():IAbstractEffect
public static function set hideEffect(value:IAbstractEffect):void

scrubDelay

propriété

scrubDelay:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Temps, en millisecondes, qu’un utilisateur peut prendre lorsqu’il déplace la souris entre les contrôles avant que Flex n’attende à nouveau la durée du contrôle showDelay pour afficher une info-bulle.

Ce paramètre est utile si l’utilisateur se déplace rapidement d’un contrôle à un autre. Après l’affichage de la première info-bulle, Flex affiche les autres immédiatement à la suite et n’attend pas. Plus le paramètre du contrôle scrubDelay est court et plus l’utilisateur est susceptible d’attendre la durée spécifiée par le contrôle showDelay avant de voir la prochaine info-bulle. Cette propriété est bien adaptée au cas suivant : vous possédez une barre d’outils dotée de plusieurs boutons et l’utilisateur les consulte tour à tour brièvement pour obtenir une rapide description de leur fonctionnalité.

La valeur par défaut est 100.

Implémentation
public static function get scrubDelay():Number
public static function set scrubDelay(value:Number):void

showDelay

propriété

showDelay:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Temps, en millisecondes, que Flex attend avant d’affiche la zone d’info-bulle une fois que l’utilisateur a déplacé la souris sur un composant doté d’une info-bulle. Pour que l’info-bulle s’affiche instantanément, définissez le contrôle showDelay sur 0.

La valeur par défaut est 500.

Implémentation
public static function get showDelay():Number
public static function set showDelay(value:Number):void

showEffect

propriété

showEffect:IAbstractEffect

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Effet qui est lu lorsqu’une info-bulle est affichée ou valeur null si l’info-bulle doit apparaître sans effet.

La valeur par défaut est null.

Implémentation
public static function get showEffect():IAbstractEffect
public static function set showEffect(value:IAbstractEffect):void

toolTipClass

propriété

toolTipClass:Class

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Classe à utiliser pour créer les infos-bulles.

La valeur par défaut est mx.controls.ToolTip.

Implémentation
public static function get toolTipClass():Class
public static function set toolTipClass(value:Class):void

Détails de la méthode

createToolTip

()

méthode

 public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip

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 une instance de la classe ToolTip avec le texte spécifié et l’affiche à l’emplacement indiqué dans les coordonnées de la scène.

Les infos-bulles apparaissent sur leur propre calque, par dessus tout autre élément à l’exception des curseurs.

Le mode d’utilisation standard des infos-bulles est de laisser la classe ToolTipManager les afficher ou les masquer automatiquement lorsque l’utilisateur déplace la souris sur les objets pour lesquels la propriété toolTip est définie. Vous pouvez désactiver cette gestion automatique des infos-bulles en définissant la propriété enabled de la classe ToolTipManager sur false.

Par contraste, cette méthode (avec destroyToolTip()) vous permet de contrôler par programme les infos-bulles. Vous pouvez les afficher où et quand vous le choisissez. Vous pouvez même en afficher plusieurs à la fois si vous en avez besoin. (La classe ToolTipManager ne le fait jamais, car cela est généralement déroutant pour l’utilisateur).

Cette méthode crée d’abord une nouvelle instance de la classe ToolTip et appelle la méthode addChild() pour la placer dans le calque des classes toolTip de l’objet SystemManager. Si vous affichez un conseil d’erreur, la méthode définit les styles appropriés. Ensuite, elle définit le texte de l’info-bulle, dimensionne l’info-bulle en fonction de son texte et la place à l’endroit que vous avez indiqué.

Vous devez enregistrer la référence à l’info-bulle que cette méthode renvoie afin de pouvoir la transmettre à la méthode destroyToolTip().

Paramètres

	`text:String` — Texte à afficher dans l’instance ToolTip.

	`x:Number` — Coordonnée horizontale de la classe ToolTip dans les coordonnées de la scène. S’il existe plusieurs scènes, la scène appropriée est déterminée à partir de l’argument `context`.

	`y:Number` — Coordonnée verticale de la classe ToolTip dans les coordonnées de la scène. S’il existe plusieurs scènes, la scène appropriée est déterminée à partir de l’argument `context`.

	`errorTipBorderStyle:String` (default = `null`) — Style de bordure d’un conseil d’erreur. L’argument de cette méthode peut être null, « errorTipRight », « errorTipAbove » ou « errorTipBelow ». S’il est de type null, la méthode `createToolTip()` crée une info-bulle normale. S’il est de type « errorTipRight », « errorTipAbove » ou « errorTipBelow », la méthode `createToolTip()` crée un conseil d’erreur et ce paramètre détermine vers quel endroit la flèche du conseil d’erreur pointe (la cible de l’erreur). Par exemple, si vous transmettez « errorTipRight », Flex place le conseil d’erreur (via les arguments x et y) à droite de la cible de l’erreur ; la flèche se trouve sur le bord gauche du conseil d’erreur.

	`context:IUIComponent` (default = `null`) — Détermine quel StyleManager est utilisé. Généralement, vous passez l’objet sur lequel l’info-bulle s’affiche de sorte que le StyleManager de l’info-bulle soit le même pour l’objet.

Valeur renvoyée

mx.core:IToolTip — Classe ToolTip récemment créée.

destroyToolTip

()

méthode

public static function destroyToolTip(toolTip:mx.core:IToolTip):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 une info-bulle spécifiée qui a été créée par la méthode createToolTip().

Cette méthode appelle la méthode removeChild() pour supprimer l’info-bulle spécifiée du calque des classes ToolTip de l’objet SystemManager. Elle sera ensuite récupérée par le garbage collector sauf si vous en gardez une référence.

Il est déconseillé d’appeler cette méthode sur l’objet currentToolTip de la classe ToolTipManager.

Paramètres

toolTip:mx.core:IToolTip — Instance ToolTip à supprimer.

Informations juridiques | Politique de confidentialité en ligne

ToolTipManager - AS3 Flex

Classes x

currentTarget

currentToolTip

enabled

hideDelay

hideEffect

scrubDelay

showDelay

showEffect

toolTipClass

createToolTip

destroyToolTip