Класс ProgressMonitor

Все реализованные интерфейсы:
Accessible
public class ProgressMonitor
extends Object
implements Accessible

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

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

Для получения дополнительной документации и примеров см. Как отслеживать прогресс — раздел в Java Tutorial.

С:
1.2
См. также:
ProgressMonitorInputStream

Вложенные классы

Модификатор и тип Класс Описание
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

Since:
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 - верхняя граница диапазона
См. также:
JDialog, JOptionPane

Методы

setProgress

public void setProgress(int nv)

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

Параметры:
nv - целое число, определяющее текущее значение, находящееся между максимальным и минимальным значениями, заданными для этого компонента
См. также:
setMinimum(int), setMaximum(int), close()

close

public void close()

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

getMinimum

public int getMinimum()

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

Возвращает:
целое число, представляющее минимальное значение
См. также:
setMinimum(int)

setMinimum

public void setMinimum(int m)

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

Параметры:
m - целое число, определяющее минимальное значение
См. также:
getMinimum()

getMaximum

public int getMaximum()

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

Возвращает:
целое число, представляющее максимальное значение
См. также:
setMaximum(int)

setMaximum

public void setMaximum(int m)

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

Параметры:
m - целое число, определяющее максимальное значение
См. также:
getMaximum()

isCanceled

public boolean isCanceled()

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

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

setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)

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

Параметры:
millisToDecideToPopup - целое число, определяющее время ожидания в миллисекундах
См. также:
getMillisToDecideToPopup()

getMillisToDecideToPopup

public int getMillisToDecideToPopup()

Возвращает время ожидания объекта перед принятием решения о появлении монитора прогресса.

Возвращает:
время ожидания в миллисекундах перед принятием решения о появлении монитора прогресса
См. также:
setMillisToDecideToPopup(int)

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

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

Параметры:
millisToPopup - целое число, определяющее время в миллисекундах
См. также:
getMillisToPopup()

getMillisToPopup

public int getMillisToPopup()

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

Возвращает:
время в миллисекундах, необходимое для появления всплывающего окна
См. также:
setMillisToPopup(int)

setNote

public void setNote(String note)

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

Параметры:
note - строка, определяющая примечание для отображения
См. также:
getNote()

getNote

public String getNote()

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

Возвращает:
строка, определяющая примечание для отображения
См. также:
setNote(java.lang.String)

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

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

© 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/javax/swing/ProgressMonitor.html

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