Класс ProgressMonitor

java.lang.Object

javax.swing.ProgressMonitor

Все реализованные интерфейсы:: Accessible

public class ProgressMonitor extends Object implements Accessible

Класс для мониторинга выполнения какой-либо операции. Если операция может занять много времени, отобразится диалоговое окно с прогрессом. При создании ProgressMonitor задаются числовой диапазон и описательная строка. По мере выполнения операции вызывается метод setProgress, чтобы указать, насколько операция продвинулась в диапазоне [min,max]. Изначально диалоговое окно отсутствует. После первых millisToDecideToPopup миллисекунд (по умолчанию 500) монитор прогресса предскажет, сколько времени займёт операция. Если время больше millisToPopup (по умолчанию 2000, 2 секунды), то будет отображено диалоговое окно с прогрессом.

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

Дополнительная документация и примеры см. на странице мониторинга прогресса в учебнике Java.

С:

1.2

См. также:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`ProgressMonitor.AccessibleProgressMonitor`	`AccessibleProgressMonitor` реализует поддержку доступности для класса `ProgressMonitor`.

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected AccessibleContext`	`accessibleContext`	`AccessibleContext` для `ProgressMonitor`

Краткое описание конструкторов

Конструктор	Описание
`ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)`	Создаёт графический объект, отображающий прогресс, обычно заполняя прямоугольную полосу по мере приближения к завершению процесса.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`close()`	Указывает, что операция завершена.
`AccessibleContext`	`getAccessibleContext()`	Возвращает `AccessibleContext` для `ProgressMonitor`
`int`	`getMaximum()`	Возвращает максимальное значение — верхний предел значения прогресса.
`int`	`getMillisToDecideToPopup()`	Возвращает время ожидания перед принятием решения о появлении монитора прогресса.
`int`	`getMillisToPopup()`	Возвращает время, необходимое для появления всплывающего окна.
`int`	`getMinimum()`	Возвращает минимальное значение — нижний предел значения прогресса.
`String`	`getNote()`	Указывает дополнительную заметку, отображаемую вместе с сообщением о прогрессе.
`boolean`	`isCanceled()`	Возвращает true, если пользователь нажал кнопку Отмена или закрыл диалоговое окно прогресса.
`void`	`setMaximum(int m)`	Устанавливает максимальное значение.
`void`	`setMillisToDecideToPopup(int millisToDecideToPopup)`	Устанавливает время ожидания перед принятием решения о появлении монитора прогресса.
`void`	`setMillisToPopup(int millisToPopup)`	Устанавливает время появления всплывающего окна.
`void`	`setMinimum(int m)`	Устанавливает минимальное значение.
`void`	`setNote(String note)`	Указывает дополнительную заметку, отображаемую вместе с сообщением о прогрессе.
`void`	`setProgress(int nv)`	Указывает прогресс выполняемой операции.

Методы, унаследованные от класса java.lang.Object

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

Подробное описание полей

accessibleContext

protected AccessibleContext accessibleContext

AccessibleContext для ProgressMonitor

С момента:: 1.5

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

ProgressMonitor

public ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)

Создаёт графический объект, отображающий прогресс, обычно заполняя прямоугольную полосу по мере приближения процесса к завершению.

Параметры:

parentComponent - родительский компонент для диалогового окна

message - описательное сообщение, которое будет отображено пользователю для указания того, какая операция отслеживается. Оно не меняется по мере выполнения операции. Смотрите параметры сообщений в методах в JOptionPane.message для диапазона значений.

note - краткое примечание, описывающее состояние операции. По мере выполнения операции вы можете вызвать setNote для изменения отображаемого примечания. Это используется, например, в операциях, которые итерируются по списку файлов, чтобы показать имя обрабатываемого файла. Если note изначально равно null, в диалоговом окне не будет строки примечания, и setNote окажется неэффективным

min - нижняя граница диапазона

max - верхняя граница диапазона

См. также:

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

setProgress

public void setProgress(int nv)

Указывает прогресс отслеживаемой операции. Если указанное значение больше или равно максимальному, монитор прогресса закрывается.

Параметры:

nv - целое число, определяющее текущее значение, находящееся между максимальным и минимальным значениями, определёнными для этого компонента

См. также:

close

public void close()

Указывает, что операция завершена. Это происходит автоматически, когда значение, заданное setProgress, больше или равно max, но может быть вызвано раньше, если операция завершается раньше срока.

getMinimum

public int getMinimum()

Возвращает минимальное значение — нижний предел значения прогресса.

Возвращает:

целое число, представляющее минимальное значение

См. также:

setMinimum

public void setMinimum(int m)

Устанавливает минимальное значение.

Параметры:

m - целое число, определяющее минимальное значение

См. также:

getMaximum

public int getMaximum()

Возвращает максимальное значение — верхний предел значения прогресса.

Возвращает:

целое число, представляющее максимальное значение

См. также:

setMaximum

public void setMaximum(int m)

Устанавливает максимальное значение.

Параметры:

m - целое число, определяющее максимальное значение

См. также:

isCanceled

public boolean isCanceled()

Возвращает true, если пользователь нажал кнопку Отмена или закрыл диалоговое окно прогресса.

Возвращает:: true, если пользователь нажал кнопку Отмена или закрыл диалоговое окно прогресса

setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)

Устанавливает время ожидания, прежде чем принять решение о появлении монитора прогресса.

Параметры:

millisToDecideToPopup - целое число, определяющее время ожидания в миллисекундах

См. также:

getMillisToDecideToPopup

public int getMillisToDecideToPopup()

Возвращает время ожидания, прежде чем принять решение о появлении монитора прогресса.

Возвращает:

время ожидания в миллисекундах, прежде чем принять решение о появлении монитора прогресса

См. также:

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

Устанавливает время, необходимое для появления всплывающего окна. (Если прогнозируемое оставшееся время меньше этого времени, всплывающее окно не будет отображаться.)

Параметры:

millisToPopup - целое число, определяющее время в миллисекундах

См. также:

getMillisToPopup

public int getMillisToPopup()

Возвращает время, необходимое для появления всплывающего окна.

Возвращает:

время в миллисекундах, необходимое для появления всплывающего окна

См. также:

setNote

public void setNote(String note)

Устанавливает дополнительное примечание, отображаемое вместе с сообщением о прогрессе. Используется, например, для отображения файла, который в данный момент копируется во время копирования нескольких файлов.

Параметры:

note - строка, определяющая отображаемое примечание

См. также:

getNote

public String getNote()

Устанавливает дополнительное примечание, отображаемое вместе с сообщением о прогрессе.

Возвращает:

строка, определяющая отображаемое примечание

См. также:

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext для ProgressMonitor

Определено в:: getAccessibleContext в интерфейсе Accessible
Возвращает:: AccessibleContext для ProgressMonitor
С момента:: 1.5

© 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/ProgressMonitor.html