Spec-Zone.ru › OpenJDK 17

Класс ProgressMonitor

java.lang.Object
javax.swing.ProgressMonitor
Все реализованные интерфейсы:
Accessible
public class ProgressMonitor extends Object implements Accessible
Класс для мониторинга хода какой-либо операции. Если операция может занять много времени, появится диалоговое окно с прогрессом. При создании ProgressMonitor задаётся числовой диапазон и описательная строка. По мере выполнения операции вызывается метод setProgress для указания, на какой стадии диапазона [min,max] находится операция. Изначально диалоговое окно Progress Dialog отсутствует. После первых millisToDecideToPopup миллисекунд (по умолчанию 500) монитор прогресса предскажет, сколько времени займёт операция. Если время окажется больше, чем millisToPopup (по умолчанию 2000, 2 секунды), появится диалоговое окно Progress Dialog.

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

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

C тех пор как:
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
Контекст доступности для объекта.
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()
Получает контекст доступности для этого объекта.
Указано:
getAccessibleContext в интерфейсе Accessible
Возвращает:
контекст доступности для этого объекта.
Since:
1.5

© 1993, 2021, 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/17/docs/api/java.desktop/javax/swing/ProgressMonitor.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API