Класс 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 class  Taskbar.Feature

Список доступных функций.
static class  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(), 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, используемый для добавления элементов к значку этого приложения в области задач системы.

Возвращает:
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.

Параметры:
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)

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

Spec-Zone .ru
спецификации, руководства, описания, API