Класс 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 |
Проверяет, поддерживается ли Feature на текущей платформе. |
static boolean |
isTaskbarSupported() |
Проверяет, поддерживается ли этот класс на текущей платформе. |
void |
requestUserAttention |
Запрашивает внимание пользователя к этому приложению. |
void |
requestWindowUserAttention |
Запрашивает внимание пользователя к указанному окну. |
void |
setIconBadge |
Добавляет небольшой значок, предоставляемый системой, к значку этого приложения. |
void |
setIconImage |
Запрашивает у системы изменить значок этого приложения на предоставленный image. |
void |
setMenu |
Присоединяет содержимое предоставленного PopupMenu к значку приложения в области задач. |
void |
setProgressValue |
Добавляет небольшую полосу прогресса, предоставляемую системой, к значку этого приложения. |
void |
setWindowIconBadge |
Добавляет небольшой значок к значку этого приложения в области задач для указанного окна. |
void |
setWindowProgressState |
Устанавливает состояние прогресса для указанного окна. |
void |
setWindowProgressValue |
Отображает детерминированную полосу прогресса в области задач для указанного окна. |
Подробное описание методов
isSupported
public boolean isSupported(Taskbar.Feature feature)
Проверяет, поддерживается ли
Feature на текущей платформе.- Параметры:
-
feature- заданныйTaskbar.Feature - Возвращает:
- true, если указанная функция поддерживается на текущей платформе
getTaskbar
public static Taskbar getTaskbar()
Возвращает экземпляр
Taskbar текущего контекста панели задач. На некоторых платформах API панели задач может быть не поддерживается; используйте метод isTaskbarSupported(), чтобы определить, поддерживается ли текущая панель задач.- Возвращает:
- экземпляр Taskbar
- Изначает исключение:
-
HeadlessException- еслиGraphicsEnvironment.isHeadless()возвращаетtrue -
UnsupportedOperationException- если этот класс не поддерживается на текущей платформе - См. также:
isTaskbarSupported
public static boolean isTaskbarSupported()
Проверяет, поддерживается ли этот класс на текущей платформе. Если он поддерживается, используйте
getTaskbar(), чтобы получить экземпляр.- Возвращает:
-
trueесли этот класс поддерживается на текущей платформе;falseв противном случае - См. также:
requestUserAttention
public void requestUserAttention(boolean enabled, boolean critical)
Запрашивает внимание пользователя для этого приложения. В зависимости от платформы, это может визуально отображаться значком, прыгающим или мигающим в области задач. Это может не иметь эффекта на уже активном приложении. На некоторых платформах (например, Mac OS) этот эффект может исчезнуть при активации приложения и не может быть отменен путем установки
enabled в значение false. На других платформах может потребоваться дополнительный вызов requestUserAttention(boolean, boolean) для отмены этого запроса с параметром enabled установленными в значение false.- Параметры:
-
enabled- отменяет этот запрос, если false -
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, используемый для добавления элементов к значку этого приложения в системной области задач.
- Возвращает:
- 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
public void setWindowProgressState(Window w, Taskbar.State state)
Устанавливает состояние прогресса для указанного окна. Не оказывает никакого эффекта, если представление окна недоступно в области задач. Его доступность зависит от типа окна, платформы и реализации.
Каждое состояние отображает прогресс зависящим от платформы способом.
Обратите внимание, что переключение из состояния
Каждое состояние отображает прогресс зависящим от платформы способом.
Обратите внимание, что переключение из состояния
INDETERMINATE в любое из определённых состояний может сбросить значение, установленное с помощью setWindowProgressValue
- Параметры:
-
w- окно -
state- в которое нужно перейти - Исключения:
-
SecurityException- если существует менеджер безопасности, который отклоняетRuntimePermission("canProcessApplicationEvents")разрешение. -
UnsupportedOperationException- если текущая платформа не поддерживает функциюTaskbar.Feature.PROGRESS_STATE_WINDOW - См. также:
© 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