public class Taskbar extends Object
Taskbar
class allows a Java application to interact with the system task area (taskbar, Dock, etc.). There are a variety of interactions depending on the current platform such as displaying progress of some task, appending user-specified menu to the application icon context menu, etc.
java.desktop.appName
system property set to this .desktop file name: Exec=java -Djava.desktop.appName=MyApp.desktop -jar /path/to/myapp.jar
see https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles
Modifier and Type | Class | Description |
---|---|---|
static enum |
Taskbar.Feature |
List of provided features. |
static enum |
Taskbar.State |
Kinds of available window progress states. |
Modifier and Type | Method | Description |
---|---|---|
Image |
getIconImage() |
Obtains an image of this application's icon. |
PopupMenu |
getMenu() |
Gets PopupMenu used to add items to this application's icon in system task area. |
static Taskbar |
getTaskbar() |
Returns the Taskbar instance of the current taskbar context. |
boolean |
isSupported |
Tests whether a Feature is supported on the current platform. |
static boolean |
isTaskbarSupported() |
Tests whether this class is supported on the current platform. |
void |
requestUserAttention |
Requests user attention to this application. |
void |
requestWindowUserAttention |
Requests user attention to the specified window. |
void |
setIconBadge |
Affixes a small system-provided badge to this application's icon. |
void |
setIconImage |
Requests the system to change this application's icon to the provided image . |
void |
setMenu |
Attaches the contents of the provided PopupMenu to the application icon in the task area. |
void |
setProgressValue |
Affixes a small system-provided progress bar to this application's icon. |
void |
setWindowIconBadge |
Affixes a small badge to this application's icon in the task area for the specified window. |
void |
setWindowProgressState |
Sets a progress state for a specified window. |
void |
setWindowProgressValue |
Displays a determinate progress bar in the task area for the specified window. |
public boolean isSupported(Taskbar.Feature feature)
Feature
is supported on the current platform.feature
- the specified Taskbar.Feature
public static Taskbar getTaskbar()
Taskbar
instance of the current taskbar context. On some platforms the Taskbar API may not be supported; use the isTaskbarSupported()
method to determine if the current taskbar is supported.HeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
UnsupportedOperationException
- if this class is not supported on the current platformpublic static boolean isTaskbarSupported()
getTaskbar()
to retrieve an instance.true
if this class is supported on the current platform; false
otherwisepublic void requestUserAttention(boolean enabled, boolean critical)
enabled
to false. Other platforms may require an additional call requestUserAttention(boolean, boolean)
to dismiss this request with enabled
parameter set to false.enabled
- disables this request if falsecritical
- if this is an important requestSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.USER_ATTENTION
featurepublic void requestWindowUserAttention(Window w)
w
- windowSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.USER_ATTENTION_WINDOW
featurepublic void setMenu(PopupMenu menu)
menu
- the PopupMenu to attach to this applicationSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.MENU
featurepublic PopupMenu getMenu()
SecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.MENU
featurepublic void setIconImage(Image image)
image
.image
- to changeSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.ICON_IMAGE
featurepublic Image getIconImage()
setIconImage(java.awt.Image)
, but should be visually similar.SecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.ICON_IMAGE
featurepublic void setIconBadge(String badge)
Feature.ICON_BADGE_TEXT
and Feature.ICON_BADGE_NUMBER
. Passing null
as parameter hides the badge.badge
- label to affix to the iconSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.ICON_BADGE_NUMBER
or Taskbar.Feature.ICON_BADGE_TEXT
featurepublic void setWindowIconBadge(Window w, Image badge)
w
- window to updatebadge
- image to affix to the iconSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.ICON_BADGE_IMAGE_WINDOW
featurepublic void setProgressValue(int value)
value
- from 0 to 100, other to disable progress indicationSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.PROGRESS_VALUE
featurepublic void setWindowProgressValue(Window w, int value)
Taskbar.State
dependent. INDETERMINATE
state of the window. w
- window to updatevalue
- from 0 to 100, other to switch to Taskbar.State.OFF
state and disable progress indicationSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.PROGRESS_VALUE_WINDOW
featurepublic void setWindowProgressState(Window w, Taskbar.State state)
INDETERMINATE
state to any of determinate states may reset value set by setWindowProgressValue
w
- windowstate
- to change toSecurityException
- if a security manager exists and it denies the RuntimePermission("canProcessApplicationEvents")
permission.UnsupportedOperationException
- if the current platform does not support the Taskbar.Feature.PROGRESS_STATE_WINDOW
feature
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/Taskbar.html