flash.desktop.DockIcon - Adobe® AIR® API Reference for HTML Developers

window.runtime property	window.runtime.flash.desktop.DockIcon

Inheritance	DockIcon InteractiveIcon Icon EventDispatcher Object

Runtime Versions:

1.0

The DockIcon class represents the Mac OS X^®-style dock icon.

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.

View the examples

Properties

Hide Inherited Public Properties

Show Inherited 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		width : int [override] [read-only] The current display width of the icon in pixels.	DockIcon

Public Methods

Hide Inherited Public Methods

Show Inherited Methods

	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
		bounce(priority:String = "informational"):void Notifies the user that an event has occurred that may require attention.	DockIcon
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

bitmaps

property

bitmaps:Array[override]

Runtime Versions:

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.

height

property

height:int [read-only] [override]

Runtime Versions:

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.

 
function createDockIconMenu(){
    if(air.NativeApplication.supportsDockIcon){                
        var dockIcon = air.NativeApplication.nativeApplication.icon;
        
        var dockMenu = new air.NativeMenu();
        var command = dockMenu.addItem(new air.NativeMenuItem("Command"));
        command.addEventListener(air.Event.SELECT, onCommand);
        
        dockIcon.menu = dockMenu;
    }
}

function onCommand(event){
     //do command...
}

width

property

width:int [read-only] [override]

Runtime Versions:

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.

Method Detail

bounce

()

method

public function bounce(priority:String = "informational"):void

Runtime Versions:

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") — The urgency with which to bounce the dock.

Example ( How to use this example )

The following example bounces the dock icon until the user activates the application:


 if(air.NativeApplication.supportsDockIcon){
     var dockIcon = air.NativeApplication.nativeApplication.icon;
     dockIcon.bounce(air.NotificationType.CRITICAL);
 }

Examples

The following example loads a sequence of images and, when the timer is started with the dock icon menu, animates the icon image. (For the example to work, you must supply a set of icon images and change the URLs in the imageURLs array.)


 <script>
        var imageURLs =  ['gfx/frame01.png',
                          'gfx/frame02.png',
                          'gfx/frame03.png',
                          'gfx/frame04.png'];
        
         var images = new Array();
         var animTimer;
                                        
         function initAnimatedDockIcon()
        {
            air.NativeApplication.nativeApplication.autoExit = false;
            loadImages();
            addMenu();
                        
            window.nativeWindow.visible = false;
        }
        
        function addMenu(){
            var menu = new air.NativeMenu();
            var start = menu.addItem(new air.NativeMenuItem("Start animation"));
            var stop = menu.addItem(new air.NativeMenuItem("Stop animation"));
            start.addEventListener(air.Event.SELECT, startTimer);
            stop.addEventListener(air.Event.SELECT, stopTimer);
            
            var dockIcon =    air.NativeApplication.nativeApplication.icon;
            dockIcon.menu = menu;
        }
        
        function startTimer(event){
            clearInterval(animTimer);
            animTimer = setInterval(advanceFrame, 100);
        }

        function stopTimer(event){
            clearInterval(animTimer);
        }

        var currentFrame = 0;
        function advanceFrame(event){
            if(currentFrame < images.length - 1){
                currentFrame++;
            } else {
                currentFrame = 0;
            }
            air.trace(currentFrame);
            air.NativeApplication.nativeApplication.icon.bitmaps = [images[currentFrame]];
        }
        

        function loadImages(event){
            if(event != null){
                images.push(event.target.content.bitmapData);
            }
            if(imageURLs.length > 0){
                var urlString = imageURLs.pop();
                var loader = new air.Loader();
                loader.contentLoaderInfo.addEventListener(air.Event.COMPLETE, loadImages, false, 0, true);
                loader.load(new air.URLRequest(urlString));
            } else {
                animTimer = setInterval(advanceFrame, 100);
            }
        }
</script>

[an error occurred while processing this directive][an error occurred while processing this directive]

Legal Notices | Online Privacy Policy