TrayIcon (Java Platform SE 6)

TrayIcon は、さまざまな MouseEvent を生成することができ、これらのイベントの通知を受け取るための対応するリスナーの追加をサポートしています。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 値を指定してこのメソッドを呼び出すと、何も起こりません。

注 -MouseEvent の座標 (TrayIcon から受け取る) は、TrayIcon ではなく、画面を基準にした値です。

Note:MOUSE_ENTERED および MOUSE_EXITED マウスイベントは、サポートされていません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:: listener - マウスモーションリスナー
関連項目:: MouseEvent, MouseListener, removeMouseListener(MouseListener), getMouseListeners()

removeMouseListener

public void removeMouseListener(MouseListener listener)

指定されたマウスリスナーを削除します。null 値または無効な値を指定してこのメソッドを呼び出すと、何も起こりません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:: 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 値を指定してこのメソッドを呼び出すと、何も起こりません。

注 -MouseEvent の座標 (TrayIcon から受け取る) は、TrayIcon ではなく、画面を基準にした値です。

Note:MOUSE_DRAGGED マウスイベントは、サポートされていません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:: listener - マウスモーションリスナー
関連項目:: MouseEvent, MouseMotionListener, removeMouseMotionListener(MouseMotionListener), getMouseMotionListeners()

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener listener)

指定されたマウスモーションリスナーを削除します。null 値または無効な値を指定してこのメソッドを呼び出すと、何も起こりません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:: 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 Threading Issues」を参照してください。

パラメータ:: listener - アクションリスナー
関連項目:: removeActionListener(java.awt.event.ActionListener), getActionListeners(), ActionListener, setActionCommand(String)

removeActionListener

public void removeActionListener(ActionListener listener)

指定されたアクションリスナーを削除します。null 値または無効な値を指定してこのメソッドを呼び出すと、何も起こりません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

パラメータ:: 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 の場合