system trayに追加できるトレイ・アイコンを表すTrayIconオブジェクト。 TrayIconには、ツールヒント(テキスト)、イメージ、ポップアップ・メニュー、およびリスナーのセットを関連付けることができます。
TrayIconは、さまざまなMouseEventsを生成することができ、これらのイベントの通知を受け取るための対応するリスナーの追加をサポートしています。 TrayIconは、一部のイベントを自身で処理します。 たとえば、デフォルトではTrayIconでマウスが右クリックされると、指定されたポップアップ・メニューを表示します。 マウスがTrayIconの上に移動すると、ツールチップに(この動作はプラットフォームに依存)と表示されます。
ノート: MouseEventが登録されたリスナーにディスパッチされると、そのcomponentプロパティがnullに設定されます。 (ComponentEvent.getComponent()を参照してください) sourceプロパティはこのTrayIconに設定されます。 (EventObject.getSource()を参照してください)
ノート: 正常に動作するTrayIcon実装では、ポップアップ・メニューの表示とトレイ・アイコンの選択に異なるジェスチャが割り当てられます。
TrayIconはActionEventを生成することがあります。 一部のプラットフォームでは、ユーザーがマウスかキーボードでトレイ・アイコンを選択すると発生します。
SecurityManagerがインストールされている場合、TrayIconを作成するには、AWTPermission accessSystemTrayが許可されている必要があります。 そうでない場合、コンストラクタはSecurityExceptionをスローします。
TrayIcon APIの使用方法の例については、SystemTrayクラスの概要を参照してください。
- 実装上のノート:
apple.awt.enableTemplateImagesプロパティを設定すると、このクラスのインスタンスに関連付けられたすべてのイメージは、ネイティブ・デスクトップ・システムによってテンプレート・イメージとして処理されます。 つまり、すべての色情報が破棄され、デスクトップのテーマや色が変更されたときにイメージが自動的に表示されるように適応されます。 このプロパティは、MacOSXにのみ影響します。- 導入されたバージョン:
- 1.6
- 関連項目:
-
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static enumメッセージ型は、メッセージのキャプションに表示されるアイコン、およびメッセージの表示時に生成されるシステム・サウンドを決定します。 -
コンストラクタのサマリー
コンストラクタ -
メソッドのサマリー
修飾子と型メソッド説明voidaddActionListener(ActionListener listener) このTrayIconからActionEventを受け取るために、指定されたアクション・リスナーを追加します。voidaddMouseListener(MouseListener listener) このTrayIconからマウス・イベントを受信するために、指定されたマウス・リスナーを追加します。voidaddMouseMotionListener(MouseMotionListener listener) このTrayIconからマウス・モーション・イベントを受け取るために、指定されたマウス・リスナーを追加します。voiddisplayMessage(String caption, String text, TrayIcon.MessageType messageType) トレイ・アイコンのそばにポップアップ・メッセージを表示します。このトレイ・アイコンでトリガーされるアクション・イベントのコマンド名を返します。このTrayIconに登録されたすべてのアクション・リスナーの配列を返します。getImage()このTrayIconに使用される現在のイメージを返します。このTrayIconに登録されたすべてのマウス・リスナーの配列を返します。このTrayIconに登録されたすべてのマウス・モーション・リスナーの配列を返します。このTrayIconに関連付けられたポップアップ・メニューを返します。getSize()システム・トレイでトレイ・アイコンが占める領域のサイズ(ピクセル単位)を返します。このTrayIconに関連付けられたツールヒント文字列を返します。booleanauto-sizeプロパティの値を返します。voidremoveActionListener(ActionListener listener) 指定されたアクション・リスナーを削除します。voidremoveMouseListener(MouseListener listener) 指定されたマウス・リスナーを削除します。voidremoveMouseMotionListener(MouseMotionListener listener) 指定されたマウス・モーション・リスナーを削除します。voidsetActionCommand(String command) このトレイ・アイコンによってトリガーされるアクション・イベントのコマンド名を設定します。voidこのTrayIconのイメージを設定します。voidsetImageAutoSize(boolean autosize) auto-sizeプロパティを設定します。voidsetPopupMenu(PopupMenu popup) このTrayIconのポップアップ・メニューを設定します。voidsetToolTip(String tooltip) このTrayIconのツールヒント文字列を設定します。
-
コンストラクタの詳細
-
TrayIcon
public TrayIcon(Image image) 指定されたイメージでTrayIconを作成します。- パラメータ:
image- 使用されるImage- 例外:
IllegalArgumentException-imageがnullである場合UnsupportedOperationException- システム・トレイが現在のプラットフォームでサポートされていない場合HeadlessException-GraphicsEnvironment.isHeadless()がtrueを返す場合SecurityException-accessSystemTrayアクセス権が許可されない場合- 関連項目:
-
TrayIcon
指定されたイメージとツールヒント・テキストでTrayIconを作成します。 ツールチップは一部のプラットフォームでは表示されない場合があります。- パラメータ:
image- 使用されるImagetooltip- ツールヒント・テキストとして使用される文字列。この値がnullである場合、ツールヒントは表示されない- 例外:
IllegalArgumentException-imageがnullである場合UnsupportedOperationException- システム・トレイが現在のプラットフォームでサポートされていない場合HeadlessException-GraphicsEnvironment.isHeadless()がtrueを返す場合SecurityException-accessSystemTrayアクセス権が許可されない場合- 関連項目:
-
TrayIcon
指定されたイメージ、ツールヒント、およびポップアップ・メニューでTrayIconを作成します。 ツールチップは一部のプラットフォームでは表示されない場合があります。- パラメータ:
image- 使用されるImagetooltip- ツールヒント・テキストとして使用される文字列。この値がnullである場合、ツールヒントは表示されないpopup- トレイ・アイコンのポップアップ・メニューで使用するメニュー。値がnullの場合、ポップアップ・メニューは表示されない- 例外:
IllegalArgumentException-imageがnullである場合UnsupportedOperationException- システム・トレイが現在のプラットフォームでサポートされていない場合HeadlessException-GraphicsEnvironment.isHeadless()がtrueを返す場合SecurityException-accessSystemTrayアクセス権が許可されない場合- 関連項目:
-
-
メソッドの詳細
-
setImage
public void setImage(Image image) このTrayIconのイメージを設定します。 以前のトレイ・アイコンのイメージは破棄され、Image.flush()メソッドは呼び出されません。これは手動で呼び出す必要があります。イメージが動画イメージを表す場合は、自動的にアニメートされます。
表示されるイメージのサイズの詳細については、
setImageAutoSize(boolean)プロパティを参照してください。現在使用しているイメージと同じイメージでこのメソッドを呼び出すと、何も起こりません。
- パラメータ:
image- 使用するnullでないImage- 例外:
NullPointerException-imageがnullである場合- 関連項目:
-
getImage
-
setPopupMenu
public void setPopupMenu(PopupMenu popup) このTrayIconのポップアップ・メニューを設定します。popupがnullの場合、ポップアップ・メニューはこのTrayIconに関連付けられません。この
popupは、トレイ・アイコンに設定する前後に親に追加しないでください。 親によっては、popupを追加してもその親から削除される場合があります。popupは1つのTrayIconだけに設定できます。 同じpopupを複数のTrayIconに設定すると、IllegalArgumentExceptionが発生します。ノート: 一部のプラットフォームでは、ユーザーがトレイ・アイコンを右クリックしたときに、ユーザー指定のポップアップ・メニュー・コンポーネントの表示がサポートされない場合があります。 この場合、メニューが表示されないか、システムによってはネイティブ・バージョンのメニューが表示されます。
- パラメータ:
popup-PopupMenu。すべてのポップアップ・メニューを削除する場合はnull- 例外:
IllegalArgumentException-popupが別のTrayIconに設定済みの場合- 関連項目:
-
getPopupMenu
public PopupMenu getPopupMenu()このTrayIconに関連付けられたポップアップ・メニューを返します。- 戻り値:
- ポップアップ・メニュー。存在しない場合は
null - 関連項目:
-
setToolTip
public void setToolTip(String tooltip) このTrayIconのツールヒント文字列を設定します。 マウスをアイコンの上に移動すると、ツールヒントは自動的に表示されます。 ツールチップは一部のプラットフォームでは表示されない場合があります。 tooltipをnullに設定すると、すべてのツールヒント・テキストが削除されます。 プラットフォームによっては、ツールヒント文字列が表示時に切り詰められることがあります。表示できる文字数は、プラットフォームに依存します。- パラメータ:
tooltip- ツールヒントの文字列。値がnullの場合、ツールヒントは表示されない- 関連項目:
-
getToolTip
-
setImageAutoSize
public void setImageAutoSize(boolean autosize) auto-sizeプロパティを設定します。 auto-sizeは、トレイ・イメージがトレイのイメージ用に割り当てられた領域に合わせて自動的にサイズ設定されるかどうかを決定します。 デフォルトでは、auto-sizeプロパティはfalseに設定されます。auto-sizeが
falseで、イメージのサイズとトレイ・アイコンの領域が一致しない場合、イメージはその領域内にそのまま描画されます。割り当てられた領域よりも大きい場合は、切り取られます。auto-sizeが
trueの場合は、トレイ・アイコンの領域に合わせて、イメージが拡大縮小されます。- パラメータ:
autosize- イメージを自動でサイズ設定する場合はtrue、そうでない場合はfalse- 関連項目:
-
isImageAutoSize
public boolean isImageAutoSize()auto-sizeプロパティの値を返します。- 戻り値:
- イメージが自動でサイズ設定される場合は
true、そうでない場合はfalse - 関連項目:
-
addMouseListener
public void addMouseListener(MouseListener listener) このTrayIconからマウス・イベントを受信するために、指定されたマウス・リスナーを追加します。null値でこのメソッドを呼び出しても、何の効果もありません。ノート: (
TrayIconから受信された)MouseEventの座標は、TrayIconではなく画面を基準にしています。ノート:
MOUSE_ENTEREDおよびMOUSE_EXITEDマウス・イベントはサポートされていません。AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
- パラメータ:
listener- マウス・リスナー- 関連項目:
-
removeMouseListener
public void removeMouseListener(MouseListener listener) - パラメータ:
listener- マウス・リスナー- 関連項目:
-
getMouseListeners
public MouseListener[] getMouseListeners()このTrayIconに登録されたすべてのマウス・リスナーの配列を返します。- 戻り値:
- この
TrayIconに登録されたすべてのMouseListeners、またはマウス・リスナーが現在登録されていない場合は空の配列 - 関連項目:
-
addMouseMotionListener
public void addMouseMotionListener(MouseMotionListener listener) このTrayIconからマウス・モーション・イベントを受け取るために、指定されたマウス・リスナーを追加します。null値でこのメソッドを呼び出しても、何の効果もありません。ノート: (
TrayIconから受信された)MouseEventの座標は、TrayIconではなく画面を基準にしています。ノート:
MOUSE_DRAGGEDマウス・イベントはサポートされていません。AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
- パラメータ:
listener- マウス・リスナー- 関連項目:
-
removeMouseMotionListener
public void removeMouseMotionListener(MouseMotionListener listener) 指定されたマウス・モーション・リスナーを削除します。nullまたは無効な値でこのメソッドを呼び出しても、何の効果もありません。AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
- パラメータ:
listener- マウス・リスナー- 関連項目:
-
getMouseMotionListeners
public MouseMotionListener[] getMouseMotionListeners()このTrayIconに登録されたすべてのマウス・モーション・リスナーの配列を返します。- 戻り値:
- この
TrayIconに登録されたすべてのMouseInputListeners、またはマウス・リスナーが現在登録されていない場合は空の配列 - 関連項目:
-
getActionCommand
public String getActionCommand()このトレイ・アイコンでトリガーされるアクション・イベントのコマンド名を返します。- 戻り値:
- アクション・コマンド名。存在しない場合は
null - 関連項目:
-
setActionCommand
public void setActionCommand(String command) このトレイ・アイコンによってトリガーされるアクション・イベントのコマンド名を設定します。 デフォルトで、このアクション・コマンドはnullに設定されています。- パラメータ:
command- トレイ・アイコンのアクション・コマンドを設定するために使用する文字列。- 関連項目:
-
addActionListener
public void addActionListener(ActionListener listener) このTrayIconからActionEventを受け取るために、指定されたアクション・リスナーを追加します。 通常、アクション・イベントは、ユーザーがマウスかキーボードを使用してトレイ・アイコンを選択すると発生します。 アクション・イベントが生成されるための条件は、プラットフォームに依存します。null値でこのメソッドを呼び出しても、何の効果もありません。AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
- パラメータ:
listener- アクション・リスナー- 関連項目:
-
removeActionListener
public void removeActionListener(ActionListener listener) 指定されたアクション・リスナーを削除します。nullまたは無効な値でこのメソッドを呼び出しても、何の効果もありません。AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
- パラメータ:
listener- アクション・リスナー- 関連項目:
-
getActionListeners
public ActionListener[] getActionListeners()このTrayIconに登録されたすべてのアクション・リスナーの配列を返します。- 戻り値:
- この
TrayIconに登録されたすべてのActionListeners、またはアクション・リスナーが現在登録されていない場合は空の配列 - 関連項目:
-
displayMessage
public void displayMessage(String caption, String text, TrayIcon.MessageType messageType) トレイ・アイコンのそばにポップアップ・メッセージを表示します。 時間が経過するか、ユーザーがクリックすると、メッセージは非表示になります。 メッセージをクリックすると、ActionEventがトリガーされることがあります。キャプションとテキストのどちらかを
nullにすることはできますが、両方をnullにするとNullPointerExceptionがスローされます。 プラットフォームによっては、キャプションまたはテキスト文字列が表示時に切り詰められることがあります。表示できる文字数は、プラットフォームに依存します。ノート: 一部のプラットフォームでは、メッセージの表示をサポートしていない可能性があります。
- パラメータ:
caption- テキストの上に表示されるキャプションで、通常は太字。nullも可text- 特定のメッセージで表示されるテキスト。nullも可messageType- メッセージ型を示す列挙- 例外:
NullPointerException-captionとtextの両方がnullの場合
-
getSize
public Dimension getSize()システム・トレイでトレイ・アイコンが占める領域のサイズ(ピクセル単位)を返します。 システム・トレイに追加されていないトレイ・アイコンの場合は、返されるサイズがSystemTray.getTrayIconSize()の結果と等しくなります。- 戻り値:
- トレイ・アイコンのサイズ(ピクセル単位)
- 関連項目:
-