Класс 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

Модификатор и тип	Метод	Описание
`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()`	Переводит текущий поток в состояние ожидания, пока он не будет разбужен, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечёт заданный промежуток реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания, пока он не будет разбужен, обычно посредством уведомления или прерывания, либо пока не истечёт заданный промежуток реального времени.

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

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.