| Package | flash.desktop |
| Classe | public class DockIcon |
| Héritage | DockIcon  InteractiveIcon Icon EventDispatcher Object |
| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.0 |
Prise en charge du profil AIR : cette fonctionnalité est prise en charge sur tous 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. Vous pouvez tester la prise en charge lors de l’exécution à l’aide de la propriété NativeApplication.supportsDockIcon. Voir Prise en charge du profil AIR pour plus d’informations sur la prise en charge de l’API dans plusieurs profils.
Vous pouvez utiliser la classe DockIcon pour modifier l’apparence de l’icône standard, par exemple pour l’animer ou lui ajouter des graphiques d’informations. Vous pouvez également ajouter des éléments au menu de l’icône du Dock. Ces éléments s’afficheront au-dessus de ceux du menu standard.
Il n’est pas possible de créer une occurrence de la classe DockIcon. Récupérez l’objet représentant l’icône du dock du système d’exploitation dans NativeApplication.icon.
Tous les systèmes d’exploitation n’ont pas d’icônes de Dock. Pour savoir si les icônes de Dock sont prises en charge par ce système, vérifiez NativeApplication.supportsDockIcon. Si les icônes de Dock sont prises en charge, la propriété NativeApplication.icon est de type DockIcon. Autrement, le type de NativeApplication.icon est une autre sous-classe de InteractiveIcon, en général SystemTrayIcon.
Important : une tentative d’appel à une méthode de la classe DockIcon 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.supportsDockIcon
flash.desktop.SystemTrayIcon
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. | DockIcon | ||
 | 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. | DockIcon | ||
| menu : NativeMenu
Menu fourni par le système de cette icône du Dock. | DockIcon | ||
| width : int [override] [lecture seule]
Largeur d’affichage actuelle de l’icône, en pixels. | DockIcon | ||
| 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 | |
Avertit l’utilisateur qu’un événement pouvant requérir son attention s’est produit. | DockIcon | ||
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
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 | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
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 | |
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 menu | propriété |
menu:NativeMenu| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.0 |
Menu fourni par le système de cette icône du Dock.
Les éléments du menu s’affichent au-dessus des éléments habituels. Les éléments habituels ne peuvent être ni modifiés ni supprimés.
Implémentation
public function get menu():NativeMenu public function set menu(value:NativeMenu):voidExemple ( Comment utiliser cet exemple )
import flash.desktop.NativeApplication;
import flash.events.Event;
private function createDockIconMenu():void{
if(NativeApplication.supportsDockIcon){
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon as DockIcon;
var dockMenu:NativeMenu = new NativeMenu();
var command:NativeMenuItem = dockMenu.addItem(new NativeMenuItem("Command"));
command.addEventListener(Event.SELECT, onCommand);
dockIcon.menu = dockMenu;
}
}
private function onCommand(event:Event):void{
//do command...
}
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():intbounce | () | méthode |
public function bounce(priority:String = "informational"):void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.0 |
Avertit l’utilisateur qu’un événement pouvant requérir son attention s’est produit.
Un appel à cette méthode fait rebondir l’icône du Dock si, et seulement si, l’application est en arrière-plan. Lorsque priority est NotificationType.Informational, il n’y a qu’un seul rebond. Lorsque priority est NotificationType.Critical, l’icône rebondit jusqu’à ce que l’application soit ramenée au premier plan.
Paramètres
priority:String (default = "informational") |
Eléments de l’API associés
Exemple ( Comment utiliser cet exemple )
import flash.display.DockIcon;
import flash.display.NotificationType;
import flash.desktop.NativeApplication;
if(NativeApplication.supportsDockIcon){
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon As DockIcon;
dockIcon.bounce(NotificationType.CRITICAL);
}
package {
import flash.desktop.DockIcon;
import flash.desktop.NativeApplication;
import flash.display.Loader;
import flash.display.NativeMenu;
import flash.display.NativeMenuItem;
import flash.display.Sprite;
import flash.events.Event;
import flash.events.TimerEvent;
import flash.net.URLRequest;
import flash.utils.Timer;
public class AnimatedDockIcon extends Sprite
{
private var imageURLs:Array = ['gfx/frame01.png',
'gfx/frame02.png',
'gfx/frame03.png',
'gfx/frame04.png'];
private var images:Array = new Array();
private var animTimer:Timer = new Timer(100);
public function AnimatedDockIcon()
{
NativeApplication.nativeApplication.autoExit = false;
addEventListener(Event.COMPLETE, loadImages);
loadImages();
animTimer.addEventListener(TimerEvent.TIMER,advanceFrame);
addMenu();
stage.nativeWindow.close();
}
private function addMenu():void{
var menu:NativeMenu = new NativeMenu();
var start:NativeMenuItem = menu.addItem(new NativeMenuItem("Start animation"));
var stop:NativeMenuItem = menu.addItem(new NativeMenuItem("Stop animation"));
start.addEventListener(Event.SELECT, startTimer);
stop.addEventListener(Event.SELECT, stopTimer);
var dockIcon:DockIcon = NativeApplication.nativeApplication.icon as DockIcon;
dockIcon.menu = menu;
}
private function startTimer(event:Event):void{
animTimer.start();
}
private function stopTimer(event:Event):void{
animTimer.stop();
}
private var currentFrame:int = 0;
private function advanceFrame(event:Event):void{
if(currentFrame < images.length){
currentFrame++;
} else {
currentFrame = 0;
}
NativeApplication.nativeApplication.icon.bitmaps = [images[currentFrame]];
}
private function loadImages(event:Event = null):void{
if(event != null){
images.push(event.target.content.bitmapData);
}
if(imageURLs.length > 0){
var urlString:String = imageURLs.pop();
var loader:Loader = new Loader();
loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loadImages, false, 0, true);
loader.load(new URLRequest(urlString));
} else {
var complete:Event = new Event(Event.COMPLETE,false,false);
dispatchEvent(complete);
}
}
}
}
Tue Jun 12 2018, 09:30 AM Z