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

Package	mx.managers
Classe	public class CursorManager
Héritage	CursorManager 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 CursorManager contrôle une liste de priorités des curseurs, dans laquelle le curseur qui a la propriété la plus élevée est actuellement visible. Si la liste des curseurs contient plusieurs curseurs de priorité identique, le gestionnaire des curseurs affiche le curseur qui a été créé le plus récemment.

Par exemple, si votre application effectue un traitement qui implique que l’utilisateur doit attendre jusqu’à la fin du traitement, vous pouvez modifier le curseur pour qu’il reflète la période d’attente. Dans ce cas, vous pouvez utiliser un sablier ou une autre image pour le curseur.

Vous pouvez également changer le curseur pour indiquer à l’utilisateur les actions qu’il peut effectuer. Par exemple, vous pouvez utiliser une image de curseur pour indiquer à l’utilisateur que la saisie est activée et un autre pour lui indiquer que la saisie est désactivée. Vous pouvez utiliser une image JPEG, GIF, PNG ou SVG, un objet Sprite ou un fichier SWF comme image de curseur.

Toutes les méthodes et propriétés de la classe CursorManager sont statiques. Vous n’avez donc pas besoin de leur créer une instance.

Dans AIR, chaque instance mx.core.Window utilise sa propre instance de la classe CursorManager. Au lieu de référencer directement les méthodes et propriétés statiques de la classe CursorManager, utilisez la propriété Window.cursorManager pour référencer l’instance CursorManager de l’instance Window.

Eléments de l’API associés

mx.managers.CursorManagerPriority
mx.core.Window

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
		currentCursorID : int [statique] ID du curseur personnalisé actuel, ou NO_CURSOR si le curseur système est affiché.	CursorManager
		currentCursorXOffset : Number [statique] Décalage x du curseur personnalisé, en pixels, par rapport au pointeur de la souris.	CursorManager
		currentCursorYOffset : Number [statique] Décalage y du curseur personnalisé, en pixels, par rapport au pointeur de la souris.	CursorManager

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		getInstance():ICursorManager [statique] Chaque instance mx.core.Window dans une application AIR possède sa propre instance CursorManager.	CursorManager
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		hideCursor():void [statique] Rend le curseur invisible.	CursorManager
		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
		removeAllCursors():void [statique] Supprime tous les curseurs de la liste des curseurs et rétablit le curseur système.	CursorManager
		removeBusyCursor():void [statique] Supprime le curseur occupé de la liste des curseurs.	CursorManager
		removeCursor(cursorID:int):void [statique] Supprime un curseur de la liste des curseurs.	CursorManager
		setBusyCursor():void [statique] Affiche le curseur occupé.	CursorManager
		setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int [statique] Crée un curseur et lui attribue une priorité facultative.	CursorManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		showCursor():void [statique] Rend le curseur visible.	CursorManager
		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

Styles

Les styles sont soit communs soit associés à un thème spécifique. Si le style est commun, il peut être utilisé avec n’importe quel thème. Si un style est associé à un thème spécifique, il ne peut être utilisé que si votre application utilise ce thème.

Styles communs

Cliquez pour plus d’informations sur les styles

	Style		Description	Défini par
		busyCursor	Type: Class Héritage CSS: Non Version du langage: ActionScript 3.0 Version du produit: Flex 3 Versions du moteur d’exécution: Flash9, AIR 1.1 Habillage du curseur occupé. La valeur par défaut est `mx.skins.halo.BusyCursor`.	CursorManager
		busyCursorBackground	Type: Class Héritage CSS: Non Version du langage: ActionScript 3.0 Version du produit: Flex 3 Versions du moteur d’exécution: Flash9, AIR 1.1 La classe à utiliser comme enveloppe du curseur d’arrière-plan occupé. La valeur par défaut est le symbole « cursorStretch » dans le fichier Assets.swf.	CursorManager

Constantes publiques

	Constante		Défini par
		NO_CURSOR : int = 0 [statique] Constante correspondant à la valeur de la propriété currentCursorID lorsqu’aucun curseur n’est géré par l’objet CursorManager et que par conséquent le curseur système est affiché.	CursorManager

Détails de la propriété

currentCursorID

propriété

currentCursorID:int

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

ID du curseur personnalisé actuel, ou NO_CURSOR si le curseur système est affiché.

Implémentation
public static function get currentCursorID():int
public static function set currentCursorID(value:int):void

currentCursorXOffset

propriété

currentCursorXOffset:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Décalage x du curseur personnalisé, en pixels, par rapport au pointeur de la souris.

La valeur par défaut est 0.

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

currentCursorYOffset

propriété

currentCursorYOffset:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Décalage y du curseur personnalisé, en pixels, par rapport au pointeur de la souris.

La valeur par défaut est 0.

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

Détails de la méthode

getInstance

()

méthode

public static function getInstance():ICursorManager

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Chaque instance mx.core.Window dans une application AIR possède sa propre instance CursorManager. Cette méthode renvoie l’instance CursorManager de l’instance Window principale.

Valeur renvoyée

ICursorManager — Instance CursorManager de l’instance Window principale dans une application AIR.

hideCursor

()

méthode

public static function hideCursor():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Rend le curseur invisible. La visibilité du curseur n’est pas fonction du nombre de références. Un seul appel de la méthode hideCursor() masque toujours le curseur, quel que soit le nombre d’appels de la méthode showCursor() effectués.

L’appel de cette méthode n’affecte pas le curseur système. Utilisez les méthodes Mouse.show() et Mouse.hide() pour contrôler directement le curseur système.

removeAllCursors

()

méthode

public static function removeAllCursors():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 tous les curseurs de la liste des curseurs et rétablit le curseur système.

removeBusyCursor

()

méthode

public static function removeBusyCursor():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 le curseur occupé de la liste des curseurs. Si d’autres demandes de curseur occupé sont toujours actives dans la liste des curseurs, ce qui signifie que vous avez appelé la méthode setBusyCursor() plusieurs fois, un curseur occupé ne peut pas disparaître tant que vous n’avez pas supprimé tous les curseurs occupés de la liste.

removeCursor

()

méthode

public static function removeCursor(cursorID:int):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 curseur de la liste des curseurs. Si le curseur en cours de suppression est le curseur actuellement affiché, l’objet CursorManager affiche le curseur suivant dans la liste, s’il en existe un. Si la liste est vide, l’objet CursorManager affiche le curseur système par défaut.

Paramètres

cursorID:int — ID du curseur à supprimer.

setBusyCursor

()

méthode

public static function setBusyCursor():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Affiche le curseur occupé. Le curseur occupé a une priorité de CursorManagerPriority.LOW. Par conséquent, si la liste des curseurs contient un curseur doté d’une priorité supérieure, le curseur occupé n’est pas affiché tant que vous n’avez pas supprimé le curseur avec la priorité supérieure. Pour créer un curseur occupé à un niveau de priorité supérieure, utilisez la méthode setCursor().

setCursor

()

méthode

public static function setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int

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 un curseur et lui attribue une priorité facultative. Ajoute le nouveau curseur à la liste des curseurs.

Paramètres

	`cursorClass:Class` — Classe du curseur à afficher.

	`priority:int` (default = `2`) — Nombre entier qui indique le niveau de priorité du curseur. Les valeurs possibles sont `CursorManagerPriority.HIGH`, `CursorManagerPriority.MEDIUM` et `CursorManagerPriority.LOW`.

	`xOffset:Number` (default = `0`) — Nombre qui définit le décalage x du curseur, en pixels, par rapport au pointeur de la souris.

	`yOffset:Number` (default = `0`) — Nombre qui définit le décalage y du curseur, en pixels, par rapport au pointeur de la souris.

Valeur renvoyée

int — ID du curseur.

Eléments de l’API associés

mx.managers.CursorManagerPriority

showCursor

()

méthode

public static function showCursor():void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Rend le curseur visible. La visibilité du curseur n’est pas fonction du nombre de références. Un seul appel de la méthode showCursor() affiche toujours le curseur, quel que soit le nombre d’appels de la méthode hideCursor() effectués.

L’appel de cette méthode n’affecte pas le curseur système. Utilisez les méthodes Mouse.show() et Mouse.hide() pour contrôler directement le curseur système.

Détails de la constante

NO_CURSOR

Constante

public static const NO_CURSOR:int = 0

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constante correspondant à la valeur de la propriété currentCursorID lorsque aucun curseur n’est géré par l’objet CursorManager et que par conséquent le curseur système est affiché.

Informations juridiques | Politique de confidentialité en ligne

CursorManager - AS3 Flex

Classes x

currentCursorID

currentCursorXOffset

currentCursorYOffset

getInstance

hideCursor

removeAllCursors

removeBusyCursor

removeCursor

setBusyCursor

setCursor

showCursor

NO_CURSOR