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 ファイル形式です。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 定数は、type プロパティ（click イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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 定数は、type プロパティ（mouseDown イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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 定数は、type プロパティ（mouseUp イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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 定数は、type プロパティ（rightClick イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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 定数は、type プロパティ（rightMouseDown イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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 定数は、type プロパティ（rightMouseUp イベントオブジェクト）の値を定義します。

このイベントには、次の関連プロパティがあります。

プロパティ	値
`buttonDown`	マウスの主ボタンが押されている場合は `true`、それ以外の場合は `false` です。
`ctrlKey`	Windows または Linux では Ctrl キーがアクティブになっている場合は、`true` です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、`true` です。それ以外の場合は `false` です。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`shiftKey`	Shift キーがアクティブになっている場合は `true`、非アクティブになっている場合は `false` です。
`commandKey`	Macintosh で 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