Класс 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)`	Отображает в области задач определённую полосу хода выполнения для указанного окна.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Проверяет, «равен ли» этот объект другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

Подробное описание методов

isSupported

public boolean isSupported(Taskbar.Feature feature)

Проверяет, поддерживается ли Feature на текущей платформе.

Параметры:: feature — указанная Taskbar.Feature
Возвращает:: true, если указанная функция поддерживается на текущей платформе

getTaskbar

public static Taskbar getTaskbar()

Возвращает экземпляр Taskbar для текущего контекста панели задач. На некоторых платформах API Taskbar может не поддерживаться; используйте метод 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 — является ли запрос важным
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.USER_ATTENTION

requestWindowUserAttention

public void requestWindowUserAttention(Window w)

Запрашивает внимание пользователя к указанному окну. Не оказывает эффекта, если представление окна не может отображаться в области задач. Возможность отображения зависит от типа окна, платформы и реализации.

Параметры:: w — окно
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.USER_ATTENTION_WINDOW

setMenu

public void setMenu(PopupMenu menu)

Добавляет содержимое указанного PopupMenu к значку приложения в области задач.

Параметры:: menu — PopupMenu, добавляемое к этому приложению
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.MENU

getMenu

public PopupMenu getMenu()

Возвращает PopupMenu, используемое для добавления элементов к значку этого приложения в системной области задач.

Возвращает:: PopupMenu
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.MENU

setIconImage

public void setIconImage(Image image)

Просит систему изменить значок этого приложения на указанное image.

Параметры:: image — изображение, на которое нужно заменить значок
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.ICON_IMAGE

getIconImage

public Image getIconImage()

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

Примечание по API:: Возвращаемое изображение значка может отличаться от изображения, заданного методом setIconImage(Image), но должно быть визуально похоже на него.
Возвращает:: изображение значка этого приложения
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.ICON_IMAGE

setIconBadge

public void setIconBadge(String badge)

Добавляет к значку этого приложения небольшой системный индикатор. Обычно это число. Некоторые платформы не поддерживают строковые значения и принимают только целые числа. В этом случае передайте в качестве параметра целое число в виде строки. Это можно проверить с помощью Feature.ICON_BADGE_TEXT и Feature.ICON_BADGE_NUMBER. Передача null в качестве параметра скрывает индикатор.

Параметры:: badge — метка, добавляемая к значку
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.ICON_BADGE_NUMBER или Taskbar.Feature.ICON_BADGE_TEXT

setWindowIconBadge

public void setWindowIconBadge(Window w, Image badge)

Добавляет небольшой индикатор к значку этого приложения в области задач для указанного окна. Индикатор может быть отключён настройками системы. Не оказывает эффекта, если представление окна не может отображаться в области задач. Возможность отображения зависит от типа окна, платформы и реализации.

Параметры:: w — окно для обновления; badge — изображение, добавляемое к значку
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.ICON_BADGE_IMAGE_WINDOW

setProgressValue

public void setProgressValue(int value)

Добавляет к значку этого приложения небольшую системную полосу хода выполнения.

Параметры:: value — от 0 до 100; любое другое значение отключает индикацию хода выполнения
Вызывает исключение:: UnsupportedOperationException — если текущая платформа не поддерживает функцию Taskbar.Feature.PROGRESS_VALUE

setWindowProgressValue

public void setWindowProgressValue(Window w, int value)

Отображает в области задач определённую полосу хода выполнения для указанного окна. Не оказывает эффекта, если представление окна не может отображаться в области задач. Возможность отображения зависит от типа окна, платформы и реализации.
Визуальное поведение зависит от платформы и состояния Taskbar.State.
Этот вызов отменяет состояние окна INDETERMINATE.
Обратите внимание: если в области задач сгруппировано несколько окон, поведение зависит от платформы.

Параметры:

w — окно для обновления

value — от 0 до 100; любое другое значение переключает в состояние Taskbar.State.OFF и отключает индикацию хода выполнения

Вызывает исключение:

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

См. также:

setWindowProgressState

public void setWindowProgressState(Window w, Taskbar.State state)

Устанавливает состояние хода выполнения для указанного окна. Не оказывает эффекта, если представление окна не может отображаться в области задач. Возможность отображения зависит от типа окна, платформы и реализации.
Каждое состояние отображает ход выполнения способом, зависящим от платформы.
Обратите внимание: переключение из состояния INDETERMINATE в любое состояние с определённым ходом выполнения может сбросить значение, установленное методом setWindowProgressValue

Параметры:

w — окно

state — состояние, в которое следует переключить

Вызывает исключение:

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

См. также:

© 1993, 2025, 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.