Класс 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)`	Изменяет значок этого приложения на предоставленное изображение.
`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(), чтобы определить, поддерживается ли текущая панель задач.

Возвращает:

экземпляр Taskbar

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true

UnsupportedOperationException - если этот класс не поддерживается на текущей платформе

См. также:

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 - отменяет запрос, если 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 - для изменения
Исключения:: SecurityException - если существует менеджер безопасности, и он отказывается предоставить разрешение RuntimePermission("canProcessApplicationEvents").; UnsupportedOperationException - если текущая платформа не поддерживает функцию Taskbar.Feature.ICON_IMAGE

getIconImage

public Image getIconImage()

Получает изображение значка этого приложения.

Возвращает:: изображение значка этого приложения
Исключения:: 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

Parameters:

w - окно

state - состояние, на которое нужно переключиться

Throws:

SecurityException - если существует менеджер безопасности, и он запрещает RuntimePermission("canProcessApplicationEvents") разрешение.

UnsupportedOperationException - если текущая платформа не поддерживает функцию Taskbar.Feature.PROGRESS_STATE_WINDOW

See Also:

© 1993, 2021, 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/17/docs/api/java.desktop/java/awt/Taskbar.html