SystemTrayIcon - Adobe ActionScript® 3 (AS3 ) API 参考

包	flash.desktop
类	public class SystemTrayIcon
继承	SystemTrayIcon InteractiveIcon Icon EventDispatcher Object

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0

SystemTrayIcon 类表示 Windows^® 任务栏通知区域（系统任务栏）样式的图标。

AIR 配置文件支持：桌面操作系统支持此功能，但移动设备或 AIR for TV 设备不支持此功能。有关在多个配置文件之间支持 API 的详细信息，请参阅 AIR 配置文件支持。

不是所有桌面操作系统都有系统任务栏图标。检查 NativeApplication.supportsSystemTrayIcon 以确定在当前系统上是否支持系统任务栏图标。

无法创建 SystemTrayIcon 类的实例。从“全局的”NativeApplication 对象的 icon 属性中获取表示系统任务栏图标的对象。

如果支持系统任务栏图标，则 icon 将为 SystemTrayIcon 类型。否则，icon 的类型将是 InteractiveIcon 的另一个子类，通常是 DockIcon。

重要说明：在 AIR 不支持系统任务栏图标的操作系统上尝试对 NativeApplication.icon 对象调用 SystemTrayIcon 类方法将生成运行时异常。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		bitmaps : Array [覆盖] 作为不同大小的 BitmapData 对象数组的图标图像。	SystemTrayIcon
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		height : int [覆盖] [只读] 图标的当前显示高度，以像素为单位。	SystemTrayIcon
		menu : NativeMenu 系统任务栏图标菜单。	SystemTrayIcon
		tooltip : String 为系统任务栏图标弹出的工具提示。	SystemTrayIcon
		width : int [覆盖] [只读] 图标的当前显示宽度，以像素为单位。	SystemTrayIcon

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
click	在鼠标单击时由此 SystemTrayIcon 对象调度。	SystemTrayIcon
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
mouseDown	在鼠标按下时由此 SystemTrayIcon 对象调度。	SystemTrayIcon
mouseUp	在鼠标弹起时由此 SystemTrayIcon 对象调度。	SystemTrayIcon
rightClick	在鼠标右键单击时由此 SystemTrayIcon 对象调度。	SystemTrayIcon
rightMouseDown	在鼠标右键按下时由此 SystemTrayIcon 对象调度。	SystemTrayIcon
rightMouseUp	在鼠标右键弹起时由此 SystemTrayIcon 对象调度。	SystemTrayIcon

公共常量

	常量		由以下参数定义
		MAX_TIP_LENGTH : Number = 63 [静态] 允许的系统任务栏图标工具提示长度。	SystemTrayIcon

属性详细信息

bitmaps

属性

bitmaps:Array[覆盖]

运行时版本:

AIR 1.0

作为不同大小的 BitmapData 对象数组的图标图像。

当在给定的操作系统上下文中显示图标时，将使用数组中最接近所显示大小的位图（必要时进行缩放）。常用的大小包括 16x16、32x32、48x48 和 128x128。（在不远的将来，某些操作系统将可以使用 512x512 像素的图标。）

在某些上下文中，如果没有为 bitmaps 属性分配任何数据，则操作系统可以使用默认的系统图标。在其他上下文中，不显示图标。

要设置或更改图标外观，请将 BitmapData 对象数组分配给 bitmaps 属性：

     icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);

直接修改 bitmaps 数组没有任何效果。

要清除图标图像，请为 bitmaps 属性分配一个空数组。

注意：在为图标加载图像文件时，PNG 文件格式通常提供最佳 Alpha 混合。GIF 格式只支持打开或关闭透明度（无混合）。JPG 格式完全不支持透明度。

实现
override public function get bitmaps():Array
override public function set bitmaps(value:Array):void

height

属性

height:int [只读] [覆盖]

运行时版本:

AIR 1.0

图标的当前显示高度，以像素为单位。

某些图标上下文支持动态大小。height 属性表示从当前上下文的 bitmaps 数组中选择的图标的高度。如果操作系统已缩放了该图标，则实际显示高度可能会有所不同。

实现
override public function get height():int

tooltip

属性

tooltip:String

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0

为系统任务栏图标弹出的工具提示。如果该字符串比 SystemTrayIcon.MAX_TIP_LENGTH 长，则将截断提示。

实现
public function get tooltip():String
public function set tooltip(value:String):void

width

属性

width:int [只读] [覆盖]

运行时版本:

AIR 1.0

图标的当前显示宽度，以像素为单位。

某些图标上下文支持动态大小。width 属性表示从当前上下文的 bitmaps 数组中选择的图标的宽度。如果操作系统已缩放了该图标，则实际显示宽度可能会有所不同。

实现
override public function get width():int

事件详细信息

click

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.CLICK

运行时版本:

AIR 1.0

在鼠标单击时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.CLICK 常量定义 click 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

mouseDown

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_DOWN

运行时版本:

AIR 1.0

在鼠标按下时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.MOUSE_DOWN 常量定义 mouseDown 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

mouseUp

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.MOUSE_UP

运行时版本:

AIR 1.0

在鼠标弹起时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.MOUSE_UP 常量定义 mouseUp 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

rightClick

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_CLICK

运行时版本:

AIR 1.0

在鼠标右键单击时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.RIGHT_CLICK 常量定义 rightClick 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

rightMouseDown

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN

运行时版本:

AIR 1.0

在鼠标右键按下时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.RIGHT_MOUSE_DOWN 常量定义 rightMouseDown 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

rightMouseUp

事件

事件对象类型: flash.events.ScreenMouseEvent
属性 ScreenMouseEvent.type = flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP

运行时版本:

AIR 1.0

在鼠标右键弹起时由此 SystemTrayIcon 对象调度。

ScreenMouseEvent.RIGHT_MOUSE_UP 常量定义 rightMouseUp 事件对象的 type 属性的值。

此事件具有以下相关属性：

属性	值
`buttonDown`	如果按下鼠标主按键，则为 `true`；否则为 `false`。
`ctrlKey`	在 Windows 或 Linux 中，如果 Ctrl 键处于活动状态，则为 `true`。在 Mac 中，如果 Ctrl 键或 Command 键处于活动状态，则为 `true`。否则为 `false`。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`shiftKey`	如果 Shift 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。
`commandKey`	在 Mac 中，如果 Command 键处于活动状态，则为 `true`；如果处于非活动状态，则为 `false`。在 Windows 中始终为 `false`。
`controlKey`	如果 Ctrl 或 Control 键处于活动状态，则为 `true`，如果处于非活动状态，则为 `false`。
`screenX`	事件发生点在屏幕坐标中的水平坐标。
`screenY`	事件发生点在屏幕坐标中的垂直坐标。
`target`	指针设备下的 SystemTrayIcon 对象。

常量详细信息

MAX_TIP_LENGTH

常量

public static const MAX_TIP_LENGTH:Number = 63

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0

允许的系统任务栏图标工具提示长度。

法律声明 | 在线隐私策略

SystemTrayIcon - AS3

包x

语言元素

附录

包 flash.desktop

bitmaps

height

menu

tooltip

width

click

mouseDown

mouseUp

rightClick

rightMouseDown

rightMouseUp

MAX_TIP_LENGTH