window.runtime property | window.runtime.flash.desktop.SystemTrayIcon |
Inheritance | SystemTrayIcon InteractiveIcon Icon EventDispatcher Object |
Runtime Versions: | 1.0 |
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.
See also
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 | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
Dispatched by this SystemTrayIcon object on mouse click. | SystemTrayIcon | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched by this SystemTrayIcon object on mouse down. | SystemTrayIcon | |||
Dispatched by this SystemTrayIcon object on mouse up. | SystemTrayIcon | |||
Dispatched by this SystemTrayIcon object on right mouse click. | SystemTrayIcon | |||
Dispatched by this SystemTrayIcon object on right mouse down. | SystemTrayIcon | |||
Dispatched by this SystemTrayIcon object on right mouse up. | SystemTrayIcon |
Constant | Defined By | ||
---|---|---|---|
MAX_TIP_LENGTH : Number = 63 [static]
The permitted length of the system tray icon tooltip. | SystemTrayIcon |
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.
menu | property |
tooltip | property |
tooltip:String
Runtime Versions: | 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.
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.
click | Event |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.CLICK
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on mouse click.
TheScreenMouseEvent.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 |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.MOUSE_DOWN
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on mouse down.
TheScreenMouseEvent.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 |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.MOUSE_UP
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on mouse up.
TheScreenMouseEvent.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 |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.RIGHT_CLICK
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on right mouse click.
TheScreenMouseEvent.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 |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on right mouse down.
TheScreenMouseEvent.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 |
flash.events.ScreenMouseEvent
property ScreenMouseEvent.type =
flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP
Runtime Versions: | 1.0 |
Dispatched by this SystemTrayIcon object on right mouse up.
TheScreenMouseEvent.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. |
MAX_TIP_LENGTH | Constant |
public static const MAX_TIP_LENGTH:Number = 63
Runtime Versions: | 1.0 |
The permitted length of the system tray icon tooltip.
Thu Sep 29 2011, 02:34 AM -07:00