模块 java.desktop

包 java.awt

类 Taskbar

java.lang.Object

java.awt.Taskbar

public class Taskbar extends Object 
      

Taskbar 类允许 Java 应用程序与系统任务区域（任务栏、Dock 等）进行交互。

根据当前平台，有多种交互方式，例如显示某些任务的进度、将用户指定的菜单附加到应用程序图标上下文菜单等。

实现注意事项：

Linux 支持目前仅限于 Unity。但是，要使这些功能在 Unity 上运行，应从 .desktop 文件运行应用程序，并将指定的 java.desktop.appName 系统属性设置为此 .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

返回：

如果当前平台支持指定的功能，则为真

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 来消除。其他平台可能需要额外调用 requestUserAttention(boolean, boolean) 以将 enabled 参数设置为 false 来驳回此请求。

参数：

enabled - 如果为假则禁用此请求

critical - 如果这是一个重要的请求

抛出：

SecurityException - 如果存在安全管理器并且它拒绝 RuntimePermission("canProcessApplicationEvents") 权限。

UnsupportedOperationException - 如果当前平台不支持 Taskbar.Feature.USER_ATTENTION 特性

requestWindowUserAttention

public void requestWindowUserAttention(Window  w)
            

请求用户注意指定的窗口。如果窗口表示在任务区域中不可显示，则无效。它是否可显示取决于所有窗口类型、平台和实现。

参数：

w - 窗口

抛出：

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。

返回：

弹出菜单

抛出：

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 - 窗口

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)