SystemTrayIcon - Adobe ActionScript® 3 (AS3 ) API Reference

Package	flash.desktop
Class	public class SystemTrayIcon
Inheritance	SystemTrayIcon InteractiveIcon Icon EventDispatcher Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The SystemTrayIcon class represents the Windows^® taskbar notification area (system tray)-style icon.

AIR profile support: This feature is supported on desktop operating systems, but it is not supported on mobile devices or AIR for TV devices. See AIR Profile Support for more information regarding API support across multiple profiles.

Not all desktop operating systems have system tray icons. Check NativeApplication.supportsSystemTrayIcon to determine whether system tray icons are supported on the current system.

An instance of the SystemTrayIcon class cannot be created. Get the object representing the system tray icon from the icon property of the "global" NativeApplication object.

When system tray icons are supported, the icon will be of type SystemTrayIcon. Otherwise, the type of icon will be another subclass of InteractiveIcon, typically DockIcon.

Important: Attempting to call a SystemTrayIcon class method on the NativeApplication.icon object on an operating system for which AIR does not support system tray icons will generate a run-time exception.

Related API Elements

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

Public Properties

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.	SystemTrayIcon
		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.	SystemTrayIcon
		menu : NativeMenu The system tray icon menu.	SystemTrayIcon
		tooltip : String The tooltip that pops up for the system tray icon.	SystemTrayIcon
		width : int [override] [read-only] The current display width of the icon in pixels.	SystemTrayIcon

Public Methods

Hide Inherited Public Methods

Show Inherited Public 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
		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

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
click	Dispatched by this SystemTrayIcon object on mouse click.	SystemTrayIcon
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
mouseDown	Dispatched by this SystemTrayIcon object on mouse down.	SystemTrayIcon
mouseUp	Dispatched by this SystemTrayIcon object on mouse up.	SystemTrayIcon
rightClick	Dispatched by this SystemTrayIcon object on right mouse click.	SystemTrayIcon
rightMouseDown	Dispatched by this SystemTrayIcon object on right mouse down.	SystemTrayIcon
rightMouseUp	Dispatched by this SystemTrayIcon object on right mouse up.	SystemTrayIcon

Public Constants

	Constant		Defined By
		MAX_TIP_LENGTH : Number = 63 [static] The permitted length of the system tray icon tooltip.	SystemTrayIcon

Property Detail

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:

Copy

     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

tooltip

property

tooltip:String

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The tooltip that pops up for the system tray icon. If the string is longer than SystemTrayIcon.MAX_TIP_LENGTH, the tip will be truncated.

Implementation
public function get tooltip():String
public function set tooltip(value:String):void

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():int

Event Detail

click

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.CLICK

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on mouse click.

The ScreenMouseEvent.CLICK constant defines the value of the type property of a click event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

mouseDown

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_DOWN

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on mouse down.

The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type property of a mouseDown event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

mouseUp

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_UP

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on mouse up.

The ScreenMouseEvent.MOUSE_UP constant defines the value of the type property of a mouseUp event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

rightClick

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_CLICK

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on right mouse click.

The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type property of a rightClick event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

rightMouseDown

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on right mouse down.

The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type property of a rightMouseDown event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

rightMouseUp

Event

Event Object Type: flash.events.ScreenMouseEvent
property ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP

Runtime Versions:

AIR 1.0

Dispatched by this SystemTrayIcon object on right mouse up.

The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type property of a rightMouseUp event object.

This event has the following relevant properties:

Property	Value
`buttonDown`	`true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey`	`true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`shiftKey`	`true` if the Shift key is active; `false` if it is inactive.
`commandKey`	`true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey`	`true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX`	The horizontal coordinate at which the event occurred in screen coordinates.
`screenY`	The vertical coordinate at which the event occurred in screen coordinates.
`target`	The SystemTrayIcon object under the pointing device.

Constant Detail

MAX_TIP_LENGTH

Constant

public static const MAX_TIP_LENGTH:Number = 63

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

The permitted length of the system tray icon tooltip.

SystemTrayIcon - AS3

Classes x

bitmaps

height

menu

tooltip

width

click

mouseDown

mouseUp

rightClick

rightMouseDown

rightMouseUp

MAX_TIP_LENGTH

flash.desktop SystemTrayIcon - AS3		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples