モジュール java.desktop

パッケージ java.awt

クラスTaskbar

java.lang.Object

java.awt.Taskbar

public class Taskbar extends Object

Taskbarクラスを使用すると、Javaアプリケーションはシステム・タスク領域(taskbar, Dock, etc.)と対話できます。

現在のプラットフォームに応じて、いくつかのタスクの進行状況の表示、アプリケーション・アイコン・コンテキスト・メニューへのユーザー指定メニューの追加など、様々な相互作用があります。

実装上のノート:

Linuxのサポートは現在、Unityに制限されています。 ただし、これらの機能をUnityで機能させるには、指定されたjava.desktop.appNameシステム・プロパティがこの.desktopファイル名に設定された.desktopファイルからアプリケーションを実行する必要があります: Exec=java -Djava.desktop.appName=MyApp.desktop -jar /path/to/myapp.jar https://help.ubuntu.com/community/UnityLaunchersAndDesktopFilesを参照してください

導入されたバージョン:

9

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

ネストされたクラス

修飾子と型	クラス	説明
static enum	Taskbar.Feature	提供される機能のリスト。
static enum	Taskbar.State	使用可能なウィンドウの進行状況の種類。

メソッドのサマリー

修飾子と型	メソッド	説明
Image	getIconImage()	このアプリケーションのアイコンのイメージを取得します。
PopupMenu	getMenu()	システム・タスク領域のこのアプリケーションのアイコンにアイテムを追加するために使用するPopupMenuを取得します。
static Taskbar	getTaskbar()	現在のタスク・バー・コンテキストのTaskbarインスタンスを返します。
boolean	isSupported(Taskbar.Feature feature)	Featureが現在のプラットフォームでサポートされているかどうかをテストします。
static boolean	isTaskbarSupported()	このクラスが現在のプラットフォームでサポートされているかどうかを判定します。
void	requestUserAttention(boolean enabled, boolean critical)	ユーザーにこのアプリケーションへの注意をリクエストします。
void	requestWindowUserAttention(Window w)	指定されたウィンドウへのユーザー対応をリクエストします。
void	setIconBadge(String badge)	システム提供の小さなバッジをこのアプリケーションのアイコンに付加します。
void	setIconImage(Image image)	このアプリケーション・アイコンを指定されたimageに変更するようシステムにリクエストします。
void	setMenu(PopupMenu menu)	指定されたPopupMenuの内容をタスク領域のアプリケーション・アイコンにアタッチします。
void	setProgressValue(int value)	システム提供の小さい進捗バーをこのアプリケーションのアイコンに付加します。
void	setWindowIconBadge(Window w, Image badge)	指定したウィンドウのタスク領域にあるこのアプリケーションのアイコンに小さなバッジを付加します。
void	setWindowProgressState(Window w, Taskbar.State state)	指定したウィンドウの進捗状態を設定します。
void	setWindowProgressValue(Window w, int value)	指定したウィンドウのタスク領域に決定進捗バーを表示します。

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

isSupported

public boolean isSupported(Taskbar.Feature feature)

Featureが現在のプラットフォームでサポートされているかどうかをテストします。

パラメータ:

feature - 指定されたTaskbar.Feature

戻り値:

指定された機能が現在のプラットフォームでサポートされている場合はtrue

getTaskbar

public static Taskbar getTaskbar()

現在のタスク・バー・コンテキストのTaskbarインスタンスを返します。 一部のプラットフォームでは、タスク・バーAPIがサポートされていない可能性があります。isTaskbarSupported()メソッドを使用して、現在のタスク・バーがサポートされているかどうかを確認します。

戻り値:

タスク・バーのインスタンス

例外:

HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返す場合

UnsupportedOperationException - このクラスが現在のプラットフォームでサポートされていない場合

関連項目:

• isTaskbarSupported()
• GraphicsEnvironment.isHeadless()

isTaskbarSupported

public static boolean isTaskbarSupported()

このクラスが現在のプラットフォームでサポートされているかどうかを判定します。 サポートされている場合は、getTaskbar()を使用してインスタンスを取得します。

戻り値:

このクラスが現在のプラットフォームでサポートされている場合はtrue、そうでない場合はfalse

関連項目:

• getTaskbar()

requestUserAttention

public void requestUserAttention(boolean enabled, boolean critical)

ユーザーにこのアプリケーションへの注意をリクエストします。 プラットフォームによっては、タスク領域でバウンスまたは点滅するアイコンによって視覚的に示される場合があります。 すでにアクティブなアプリケーションには影響しない可能性があります。 一部のプラットフォームでは、(例えばMac OS)は、アプリケーションのアクティブ化時にこの効果が消える可能性があり、enabledをfalseに設定することで解消できません。 他のプラットフォームでは、enabledパラメータをfalseに設定してこのリクエストを終了するために、追加のコールrequestUserAttention(boolean, boolean)が必要になる場合があります。

パラメータ:

enabled - falseの場合はこのリクエストを無効にします

critical - これが重要なリクエストであれば

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.USER_ATTENTION機能をサポートしていない場合

requestWindowUserAttention

public void requestWindowUserAttention(Window w)

指定されたウィンドウへのユーザー対応をリクエストします。 ウィンドウ表現がタスク領域に表示できない場合、効果はありません。 表示可能かどうかは、すべてのウィンドウ・タイプ、プラットフォームおよび実装に依存します。

パラメータ:

w - window

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.USER_ATTENTION_WINDOW機能をサポートしていない場合

setMenu

public void setMenu(PopupMenu menu)

指定されたPopupMenuの内容をタスク領域のアプリケーション・アイコンにアタッチします。

パラメータ:

menu - このアプリケーションにアタッチするPopupMenu

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.MENU機能をサポートしていない場合

getMenu

public PopupMenu getMenu()

システム・タスク領域のこのアプリケーションのアイコンにアイテムを追加するために使用するPopupMenuを取得します。

戻り値:

the PopupMenu

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.MENU機能をサポートしていない場合

setIconImage

public void setIconImage(Image image)

このアプリケーション・アイコンを指定されたimageに変更するようシステムにリクエストします。

パラメータ:

image - 変更

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_IMAGE機能をサポートしていない場合

getIconImage

public Image getIconImage()

このアプリケーションのアイコンのイメージを取得します。

APIのノート:

返されるアイコン・イメージは、setIconImage(java.awt.Image)で設定されたイメージと等しくない場合がありますが、視覚的に類似している必要があります。

戻り値:

このアプリケーションのアイコンのイメージ

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_IMAGE機能をサポートしていない場合

setIconBadge

public void setIconBadge(String badge)

システム提供の小さなバッジをこのアプリケーションのアイコンに付加します。 通常は数字です。 一部のプラットフォームは文字列値をサポートせず、整数値のみを受け入れます。 この場合、文字列として表される整数をパラメータとして渡します。 これはFeature.ICON_BADGE_TEXTとFeature.ICON_BADGE_NUMBERでテストできます。 パラメータとしてnullを渡すと、バッジが非表示になります。

パラメータ:

badge - アイコンに付けるラベル

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_BADGE_NUMBERまたはTaskbar.Feature.ICON_BADGE_TEXT機能をサポートしていない場合

setWindowIconBadge

public void setWindowIconBadge(Window w, Image badge)

指定したウィンドウのタスク領域にあるこのアプリケーションのアイコンに小さなバッジを付加します。 システム設定によって無効になる場合があります。 ウィンドウ表現がタスク領域に表示できない場合、効果はありません。 表示可能かどうかは、すべてのウィンドウ・タイプ、プラットフォームおよび実装に依存します。

パラメータ:

w - 更新するウィンドウ

badge - アイコンに貼り付けるイメージ

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.ICON_BADGE_IMAGE_WINDOW機能をサポートしていない場合

setProgressValue

public void setProgressValue(int value)

システム提供の小さい進捗バーをこのアプリケーションのアイコンに付加します。

パラメータ:

value - 0から100まで、進捗表示を無効にする他

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.PROGRESS_VALUE機能をサポートしていない場合

setWindowProgressValue

public void setWindowProgressValue(Window w, int value)

指定したウィンドウのタスク領域に決定進捗バーを表示します。 ウィンドウ表現がタスク領域に表示できない場合、効果はありません。 表示可能かどうかは、すべてのウィンドウ・タイプ、プラットフォームおよび実装に依存します。
視覚的な動作はプラットフォームおよびTaskbar.Stateに依存します。
このコールは、ウィンドウのINDETERMINATE状態を取り消します。
複数のウィンドウがタスク領域にグループ化されている場合、動作はプラットフォーム固有であることに注意してください。

パラメータ:

w - 更新するウィンドウ

value - 0から100まで、他はTaskbar.State.OFF状態に切り替え、進捗表示を無効にします

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.PROGRESS_VALUE_WINDOW機能をサポートしていない場合

関連項目:

• setWindowProgressState(java.awt.Window, State)

setWindowProgressState

public void setWindowProgressState(Window w, Taskbar.State state)

指定したウィンドウの進捗状態を設定します。 ウィンドウ表現がタスク領域に表示できない場合、効果はありません。 表示可能かどうかは、すべてのウィンドウ・タイプ、プラットフォームおよび実装に依存します。
各状態は、プラットフォームに依存した方法で進行状況を表示します。
INDETERMINATE状態から確定状態のいずれかに切り替えることは、setWindowProgressValueによって設定された値をリセットする可能性があります

パラメータ:

w - window

state - に変更

例外:

SecurityException - セキュリティ・マネージャが存在し、RuntimePermission("canProcessApplicationEvents")権限を拒否する場合。

UnsupportedOperationException - 現在のプラットフォームがTaskbar.Feature.PROGRESS_STATE_WINDOW機能をサポートしていない場合

関連項目:

• Taskbar.State.OFF
• Taskbar.State.NORMAL
• Taskbar.State.PAUSED
• Taskbar.State.ERROR
• Taskbar.State.INDETERMINATE
• setWindowProgressValue(java.awt.Window, int)