| Package | flash.desktop |
| Class | public class DockIcon |
| Inheritance | DockIcon  InteractiveIcon Icon EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
AIR profile support: This feature is supported on
all desktop operating systems, but it is not supported on mobile devices or AIR for TV devices. You can test
for support at run time using the NativeApplication.supportsDockIcon property. See
AIR Profile Support for more information regarding API support across multiple profiles.
You can use the DockIcon class to change the appearance of the standard icon; for example, to animate the icon or add informational graphics. You can also add items to the dock icon menu. The menu items that you add are displayed above the standard menu items.
An instance of the DockIcon class cannot be created. Get the object
representing the operating system dock icon from NativeApplication.icon.
Not all operating systems have dock icons. Check NativeApplication.supportsDockIcon
to determine whether dock icons are supported on the current system. If dock
icons are supported, the NativeApplication.icon property is of type
DockIcon. Otherwise, the type of NativeApplication.icon is another
subclass of InteractiveIcon, typically SystemTrayIcon.
Important: Attempting to call a DockIcon class method on the
NativeApplication.icon object on an operating system for which AIR does not support dock icons
generates a run-time exception.
Related API Elements
flash.desktop.NativeApplication.supportsDockIcon
flash.desktop.SystemTrayIcon
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| bitmaps : Array [override]
The icon image as an array of BitmapData objects of different sizes. | DockIcon | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| height : int [override] [read-only]
The current display height of the icon in pixels. | DockIcon | ||
| menu : NativeMenu
The system-supplied menu of this dock icon. | DockIcon | ||
| width : int [override] [read-only]
The current display width of the icon in pixels. | DockIcon | ||
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Notifies the user that an event has occurred that may require attention. | DockIcon | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
bitmaps | property |
bitmaps:Array[override] | Runtime Versions: | AIR 1.0 |
The icon image as an array of BitmapData objects of different sizes.
When an icon is displayed in a given operating system context, the bitmap in the array closest to the displayed size is used (and scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and 128x128. (512x512 pixel icons may be used for some operating system icons in the near future.)
In some contexts, the operating system may use a default system icon
if nothing has been assigned to the bitmaps property.
In other contexts, no icon appears.
To set or change the icon appearance, assign an array of
BitmapData objects to the bitmaps property:
icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);
Modifying the bitmaps array directly has no effect.
To clear the icon image, assign an empty array to the
bitmaps property.
Note: When loading image files for an icon, the PNG file format generally provides the best alpha blending. The GIF format supports only on or off transparency (no blending). The JPG format does not support transparency at all.
Implementation
override public function get bitmaps():Array override public function set bitmaps(value:Array):void height | property |
height:int [read-only] [override] | Runtime Versions: | AIR 1.0 |
The current display height of the icon in pixels.
Some icon contexts support dynamic sizes.
The height property indicates the height of the icon chosen from the bitmaps array
for the current context. The actual display height may be different if the operating system
has scaled the icon.
Implementation
override public function get height():int menu | property |
menu:NativeMenu| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The system-supplied menu of this dock icon.
Any items in the menu are displayed above the standard items. The standard items cannot be modified or removed.
Implementation
public function get menu():NativeMenu public function set menu(value:NativeMenu):voidExample ( How to use this example )
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 | property |
width:int [read-only] [override] | Runtime Versions: | AIR 1.0 |
The current display width of the icon in pixels.
Some icon contexts support dynamic sizes.
The width property indicates the width of the icon chosen from the bitmaps array
for the current context. The actual display width may be different if the operating system
has scaled the icon.
Implementation
override public function get width():intbounce | () | method |
public function bounce(priority:String = "informational"):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Notifies the user that an event has occurred that may require attention.
Calling this method bounces the dock icon if, and only if, the
application is in the background. If the priority is
NotificationType.Informational then the icon bounces once.
If the priority is NotificationType.Critical then the
icon bounces until the application is brought to the foreground.
Parameters
priority:String (default = "informational") |
Related API Elements
Example ( How to use this example )
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);
}
}
}
}
Wed Nov 21 2018, 06:34 AM -08:00