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 屬性取得代表系統匣圖示的物件。

支援系統匣圖示時，此圖示的類型將會是 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

bitmaps

height

menu

tooltip

width

click

mouseDown

mouseUp

rightClick

rightMouseDown

rightMouseUp

MAX_TIP_LENGTH