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

Package	flash.desktop
Classe	public class SystemTrayIcon
Héritage	SystemTrayIcon InteractiveIcon Icon EventDispatcher Object

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

La classe SystemTrayIcon représente l’icône de style de la zone de notification de la barre des tâches de Windows^® (barre d’état système).

Prise en charge du profil AIR : cette fonctionnalité est prise en charge sur les systèmes d’exploitation de bureau, mais ne l’est pas sur les périphériques mobiles ou sur les périphériques AIR pour TV. Voir Prise en charge du profil AIR pour plus d’informations sur la prise en charge de l’API dans plusieurs profils.

Tous les systèmes d’exploitation de bureau ne disposent pas d’icônes sur la barre d’état système. Pour savoir si les icônes de barre d’état système sont prises en charge par le système en cours, vérifiez NativeApplication.supportsSystemTrayIcon.

Il n’est pas possible de créer une occurrence de la classe SystemTrayIcon. Récupérez l’objet représentant l’icône de barre d’état système dans la propriété icon de l’objet NativeApplication « global ».

Lorsque ces icônes sont prises en charge, l’icône est de type SystemTrayIcon. Autrement, le type de icon est une autre sous-classe de InteractiveIcon, en général DockIcon.

Important : une tentative d’appel à une méthode de la classe SystemTrayIcon sur l’objet NativeApplication.icon dans un système d’exploitation pour lequel AIR ne prend pas en charge les icônes de barre d’état système génère une exception à l’exécution.

Eléments de l’API associés

flash.desktop.NativeApplication.icon
flash.desktop.NativeApplication.supportsSystemTrayIcon
flash.desktop.DockIcon

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
		bitmaps : Array [override] Image de l’icône sous forme de tableau d’objets BitmapData de tailles différentes.	SystemTrayIcon
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		height : int [override] [lecture seule] Hauteur d’affichage actuelle de l’icône, en pixels.	SystemTrayIcon
		menu : NativeMenu Menu de l’icône de barre d’état système.	SystemTrayIcon
		tooltip : String Info-bulle qui s’affiche pour l’icône de barre d’état système.	SystemTrayIcon
		width : int [override] [lecture seule] Largeur d’affichage actuelle de l’icône, en pixels.	SystemTrayIcon

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

	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
click	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur clique avec sa souris.	SystemTrayIcon
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
mouseDown	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur enfonce le bouton de sa souris.	SystemTrayIcon
mouseUp	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur relâche le bouton de sa souris.	SystemTrayIcon
rightClick	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur clique du bouton droit de sa souris.	SystemTrayIcon
rightMouseDown	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur enfonce le bouton droit de sa souris.	SystemTrayIcon
rightMouseUp	Distribué par cet objet SystemTrayIcon lorsque l’utilisateur relâche le bouton droit de sa souris.	SystemTrayIcon

Constantes publiques

	Constante		Défini par
		MAX_TIP_LENGTH : Number = 63 [statique] Longueur autorisée de l’info-bulle de l’icône de la barre d’état système.	SystemTrayIcon

Détails de la propriété

bitmaps

propriété

bitmaps:Array[override]

Versions du moteur d’exécution:

AIR 1.0

Image de l’icône sous forme de tableau d’objets BitmapData de tailles différentes.

Lorsqu’une icône est affichée dans le contexte d’un certain système d’exploitation, l’image bitmap du tableau se rapprochant le plus de la taille affichée est utilisée (et éventuellement mise à l’échelle). Les tailles courantes sont 16x16, 32x32, 48x48 et 128x128 (des icônes de 512x512 pixels peuvent être utilisées pour des système d’exploitation futurs).

Dans certains cas, le système d’exploitation peut utiliser une icône système par défaut lorsque rien n’a été affecté à la propriété bitmaps. Dans d’autres cas, aucune icône n’apparaît.

Pour définir ou modifier l’apparence de l’icône, affectez un tableau d’objets bitmapData à la propriété bitmaps :

     icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);

La modification directe du tableau bitmaps n’a aucun effet.

Pour effacer l’image de l’icône, affectez un tableau vide à la propriété bitmaps.

Remarque : lors du chargement de fichiers image pour une icône, le format de fichier PNG fournit généralement la meilleure fusion alpha. Le format GIF ne prend en charge que l’activation ou la désactivation de la transparence (pas la fusion). Le format JPG ne prend pas en charge la transparence du tout.

Implémentation
override public function get bitmaps():Array
override public function set bitmaps(value:Array):void

height

propriété

height:int [lecture seule] [override]

Versions du moteur d’exécution:

AIR 1.0

Hauteur d’affichage actuelle de l’icône, en pixels.

Certains contextes d’icône prennent en charge les tailles dynamiques. La propriété height indique la hauteur de l’icône choisie dans le tableau bitmaps pour le contexte actuel. La hauteur d’affichage réelle peut être différente si le système d’exploitation a mis l’icône à l’échelle.

Implémentation
override public function get height():int

tooltip

propriété

tooltip:String

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Info-bulle qui s’affiche pour l’icône de barre d’état système. Si la longueur est supérieure à SystemTrayIcon.MAX_TIP_LENGTH, l’info-bulle est tronquée.

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

width

propriété

width:int [lecture seule] [override]

Versions du moteur d’exécution:

AIR 1.0

Largeur d’affichage actuelle de l’icône, en pixels.

Certains contextes d’icône prennent en charge les tailles dynamiques. La propriété width indique la largeur de l’icône choisie dans le tableau bitmaps pour le contexte actuel. La largeur d’affichage réelle peut être différente si le système d’exploitation a mis l’icône à l’échelle.

Implémentation
override public function get width():int

Détails de l’événement

click

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.CLICK

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur clique avec sa souris.

La constante ScreenMouseEvent.CLICK définit la valeur de la propriété type d’un objet d’événement click.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

mouseDown

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_DOWN

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur enfonce le bouton de sa souris.

La constante ScreenMouseEvent.MOUSE_DOWN définit la valeur de la propriété type d’un objet événement mouseDown.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

mouseUp

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_UP

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur relâche le bouton de sa souris.

La constante ScreenMouseEvent.MOUSE_UP définit la valeur de la propriété type d’un objet événement mouseUp.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

rightClick

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_CLICK

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur clique du bouton droit de sa souris.

La constante ScreenMouseEvent.RIGHT_CLICK définit la valeur de la propriété type d’un objet événement rightClick.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

rightMouseDown

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur enfonce le bouton droit de sa souris.

La constante ScreenMouseEvent.RIGHT_MOUSE_DOWN définit la valeur de la propriété type d’un objet événement rightMouseDown.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

rightMouseUp

Evénement

Type d’objet d’événement: flash.events.ScreenMouseEvent
propriété ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP

Versions du moteur d’exécution:

AIR 1.0

Distribué par cet objet SystemTrayIcon lorsque l’utilisateur relâche le bouton droit de sa souris.

La constante ScreenMouseEvent.RIGHT_MOUSE_UP définit la valeur de la propriété type d’un objet événement rightMouseUp.

Les principales propriétés de cet événement sont les suivantes :

Propriété	Valeur
`buttonDown`	`true` si le bouton principal de la souris est enfoncé ; `false` dans tous les autres cas.
`ctrlKey`	`true` sous Windows ou Linux si la touche Ctrl est enfoncée. `true` sur Mac si la touche Ctrl ou la touche Commande est activée. Sinon, la valeur `false` est renvoyée.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`shiftKey`	`true` si la touche Maj est activée ; `false` si elle ne l’est pas.
`commandKey`	`true` sur le Mac si la touche Commande est activée ; `false` si elle est désactivée. Toujours `false` sur Windows.
`controlKey`	`true` si la touche Ctrl ou Contrôle est activée ; `false` si elle est désactivée.
`screenX`	Coordonnée horizontale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`screenY`	Coordonnée verticale à laquelle l’événement s’est produit, par rapport aux coordonnées de l’écran.
`target`	L’objet SystemTrayIcon sous le périphérique de pointage.

Détails de la constante

MAX_TIP_LENGTH

Constante

public static const MAX_TIP_LENGTH:Number = 63

Version du langage:

ActionScript 3.0

Versions du moteur d’exécution:

AIR 1.0

Longueur autorisée de l’info-bulle de l’icône de la barre d’état système.

Informations juridiques | Politique de confidentialité en ligne

SystemTrayIcon - AS3

Classes x

bitmaps

height

menu

tooltip

width

click

mouseDown

mouseUp

rightClick

rightMouseDown

rightMouseUp

MAX_TIP_LENGTH