Класс ProgressMonitor

java.lang.Object

javax.swing.ProgressMonitor

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

public class ProgressMonitor extends Object implements Accessible

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

Время от времени, когда диалоговое окно видимо, индикатор выполнения обновляется при вызове 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)`	Указывает ход выполнения отслеживаемой операции.

Методы, объявленные в классе 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 — описательное сообщение, которое будет показано пользователю и укажет, какая операция отслеживается. Оно не меняется по мере выполнения операции. Допустимые значения см. в описании параметров 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/ProgressMonitor.html