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