TrayIcon (Java Platform SE 8)

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を作成するには、AWTPermission accessSystemTrayが許可されている必要があります。そうでない場合、コンストラクタはSecurityExceptionをスローします。
TrayIcon APIの使用方法の例については、SystemTrayクラスの概要を参照してください。

導入されたバージョン:

1.6

関連項目:

SystemTray.add(java.awt.TrayIcon), ComponentEvent.getComponent(), EventObject.getSource()

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`TrayIcon.MessageType` メッセージ型は、メッセージのキャプションに表示されるアイコン、およびメッセージの表示時に生成されるシステム・サウンドを決定します。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`TrayIcon(Image image)` 指定されたイメージで`TrayIcon`を作成します。
`TrayIcon(Image image, String tooltip)` 指定されたイメージとツールヒント・テキストで`TrayIcon`を作成します。
`TrayIcon(Image image, String tooltip, PopupMenu popup)` 指定されたイメージ、ツールヒント、およびポップアップ・メニューで`TrayIcon`を作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`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`のツールヒント文字列を設定します。

クラス java.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - 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)
```
    指定されたマウス・リスナーを削除します。nullまたは無効な値でこのメソッドを呼び出しても、何の効果もありません。
    AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。
    
    パラメータ:
    
    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()

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスTrayIcon

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Objectから継承されたメソッド

コンストラクタの詳細

TrayIcon

TrayIcon

TrayIcon

メソッドの詳細

setImage

getImage

setPopupMenu

getPopupMenu

setToolTip

getToolTip

setImageAutoSize

isImageAutoSize

addMouseListener

removeMouseListener

getMouseListeners

addMouseMotionListener

removeMouseMotionListener

getMouseMotionListeners

getActionCommand

setActionCommand

addActionListener

removeActionListener

getActionListeners

displayMessage

getSize