Класс ProgressMonitor

public class ProgressMonitor
extends Object
implements Accessible

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

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

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

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

accessibleContext

protected 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, если пользователь нажал кнопку «Отмена» в диалоговом окне прогресса.

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()

Получает контекст доступности для ProgressMonitor

Определено в:

getAccessibleContext в интерфейсе Accessible

Возвращает:

контекст доступности для ProgressMonitor

Since:

1.5