Класс JProgressBar

public class JProgressBar
extends JComponent
implements SwingConstants, Accessible

Компонент, визуально отображающий прогресс какой-либо задачи. По мере приближения задачи к завершению, полоса прогресса отображает процент завершения задачи. Этот процент обычно представлен визуально прямоугольником, который изначально пустой и постепенно заполняется по мере выполнения задачи. Кроме того, полоса прогресса может отображать текстовое представление этого процента.

JProgressBar использует BoundedRangeModel в качестве модели данных, при этом свойство value представляет "текущее" состояние задачи, а свойства minimum и maximum — начальную и конечную точки соответственно.

Чтобы указать, что выполняется задача неизвестной длины, вы можете перевести полосу прогресса в режим неопределённости. Пока полоса находится в режиме неопределённости, она постоянно анимируется, чтобы показать, что выполняется работа. Как только вы сможете определить длину задачи и степень прогресса, вы должны обновить значение полосы прогресса и переключиться обратно на режим определённости.

Вот пример создания полосы прогресса, где task — объект (представляющий некую работу), который возвращает информацию о прогрессе задачи:

progressBar = new JProgressBar(0, task.getLengthOfTask());
progressBar.setValue(0);
progressBar.setStringPainted(true);

Вот пример запроса текущего состояния задачи и использования возвращённого значения для обновления полосы прогресса:

progressBar.setValue(task.getCurrent());

Вот пример перевода полосы прогресса в режим неопределённости, а затем возврата в режим определённости, после того как станет известна длина задачи:

progressBar = new JProgressBar();
...//when the task of (initially) unknown length begins:
progressBar.setIndeterminate(true);
...//do some work; get length of task...
progressBar.setMaximum(newLength);
progressBar.setValue(newValue);
progressBar.setIndeterminate(false);

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

Предупреждение: Swing не является потокобезопасным. Для получения дополнительной информации см. Политику потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, работающими с одной и той же версией Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. См. XMLEncoder.

Поля

orientation

protected int orientation

Указывает, является ли полоса прогресса горизонтальной или вертикальной. По умолчанию HORIZONTAL.

См. также:

setOrientation(int)

paintBorder

protected boolean paintBorder

Отображать ли рамку вокруг полосы прогресса. По умолчанию true.

См. также:

setBorderPainted(boolean)

model

protected BoundedRangeModel model

Объект, содержащий данные для полосы прогресса.

См. также:

setModel(javax.swing.BoundedRangeModel)

progressString

protected String progressString

Необязательная строка, которая может быть отображена на полосе прогресса. По умолчанию null. Установка значения, отличного от null, не гарантирует отображение строки. Для отображения строки необходимо, чтобы paintString было true.

См. также:

setString(java.lang.String), setStringPainted(boolean)

paintString

protected boolean paintString

Отображать ли строку текста на полосе прогресса. По умолчанию false. Установка значения true вызывает рендеринг текстового отображения прогресса на полосе прогресса. Если progressString равно null, отображается процент завершения на полосе прогресса. В противном случае на полосе прогресса отображается progressString.

См. также:

setStringPainted(boolean), setString(java.lang.String)

changeEvent

protected transient ChangeEvent changeEvent

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

См. также:

fireStateChanged()

changeListener

protected ChangeListener changeListener

Прослушивает события изменения, отправляемые моделью полосы прогресса, перенаправляя их слушателям событий изменения, зарегистрированным на этой полосе прогресса.

См. также:

createChangeListener()

Конструкторы

JProgressBar

public JProgressBar()

Создает горизонтальную полосу прогресса, отображающую рамку, но без строки прогресса. Начальное и минимальное значения равны 0, максимальное — 100.

См. также:

setOrientation(int), setBorderPainted(boolean), setStringPainted(boolean), setString(java.lang.String), setIndeterminate(boolean)

JProgressBar

public JProgressBar(int orient)

Создает полосу прогресса с указанной ориентацией, которая может быть либо SwingConstants.VERTICAL, либо SwingConstants.HORIZONTAL. По умолчанию отображается рамка, но строка прогресса нет. Начальное и минимальное значения равны 0, максимальное — 100.

Параметры:

orient - желаемая ориентация полосы прогресса

Исключения:

IllegalArgumentException - если orient является недопустимым значением

См. также:

setOrientation(int), setBorderPainted(boolean), setStringPainted(boolean), setString(java.lang.String), setIndeterminate(boolean)

JProgressBar

public JProgressBar(int min,
                    int max)

Параметры:

min - минимальное значение полосы прогресса

max - максимальное значение полосы прогресса

См. также:

BoundedRangeModel, setOrientation(int), setBorderPainted(boolean), setStringPainted(boolean), setString(java.lang.String), setIndeterminate(boolean)

JProgressBar

public JProgressBar(int orient,
                    int min,
                    int max)

Параметры:

orient - желаемая ориентация полосы прогресса

min - минимальное значение полосы прогресса

max - максимальное значение полосы прогресса

Исключения:

IllegalArgumentException - если orient является недопустимым значением

См. также:

BoundedRangeModel, setOrientation(int), setBorderPainted(boolean), setStringPainted(boolean), setString(java.lang.String), setIndeterminate(boolean)

JProgressBar

public JProgressBar(BoundedRangeModel newModel)

Создает горизонтальную полосу прогресса, которая использует указанную модель для хранения данных полосы прогресса. По умолчанию отображается рамка, но строка прогресса нет.

Параметры:

newModel - модель данных для полосы прогресса

См. также:

setOrientation(int), setBorderPainted(boolean), setStringPainted(boolean), setString(java.lang.String), setIndeterminate(boolean)

Методы

getOrientation

public int getOrientation()

Возвращает SwingConstants.VERTICAL или SwingConstants.HORIZONTAL, в зависимости от ориентации полосы прогресса. По умолчанию ориентация SwingConstants.HORIZONTAL.

Возвращает:

HORIZONTAL или VERTICAL

См. также:

setOrientation(int)

setOrientation

public void setOrientation(int newOrientation)

Устанавливает ориентацию полосы прогресса на newOrientation, которая должна быть SwingConstants.VERTICAL или SwingConstants.HORIZONTAL. По умолчанию ориентация SwingConstants.HORIZONTAL.

Параметры:

newOrientation - HORIZONTAL или VERTICAL

Исключения:

IllegalArgumentException - если newOrientation является недопустимым значением

См. также:

getOrientation()

isStringPainted

public boolean isStringPainted()

Возвращает значение свойства stringPainted.

Возвращает:

значение свойства stringPainted

См. также:

setStringPainted(boolean), setString(java.lang.String)

setStringPainted

public void setStringPainted(boolean b)

Устанавливает значение свойства stringPainted, которое определяет, следует ли полосе прогресса рендерить строку прогресса. По умолчанию false, что означает, что строка не отрисовывается. Некоторые визуальные стили могут не поддерживать строки прогресса или поддерживать их только в определенном режиме полосы прогресса.

Параметры:

b - true, если полоса прогресса должна рендерить строку

См. также:

isStringPainted(), setString(java.lang.String)

getString

public String getString()

Возвращает строковое представление текущего прогресса. По умолчанию возвращает простой процент String, основанный на значении, возвращенном из getPercentComplete. Примером является "42%". Можно изменить это, вызвав setString.

Возвращает:

значение строки прогресса или простая строка процента, если строка прогресса null

См. также:

setString(java.lang.String)

setString

public void setString(String s)

Параметры:

s - значение строки прогресса

См. также:

getString(), setStringPainted(boolean), isStringPainted()

getPercentComplete

public double getPercentComplete()

Возвращает процент выполнения для полосы прогресса. Обратите внимание, что это число находится в диапазоне от 0.0 до 1.0.

Возвращает:

процент выполнения для этой полосы прогресса

isBorderPainted

public boolean isBorderPainted()

Возвращает свойство borderPainted.

Возвращает:

значение свойства borderPainted

См. также:

setBorderPainted(boolean)

setBorderPainted

public void setBorderPainted(boolean b)

Устанавливает свойство borderPainted, которое равно true, если полоса прогресса должна отображать свою границу. Значение по умолчанию для этого свойства — true. Некоторые стили отображения могут не реализовывать отрисовку границ; в таком случае они проигнорируют это свойство.

Параметры:

b - true, если полоса прогресса должна отображать свою границу; в противном случае, false

См. также:

isBorderPainted()

paintBorder

protected void paintBorder(Graphics g)

Отображает границу полосы прогресса, если свойство borderPainted равно true.

Переопределяет:

paintBorder в классе JComponent

Параметры:

g - контекст Graphics, в котором необходимо отобразить границу

См. также:

JComponent.paint(java.awt.Graphics), JComponent.setBorder(javax.swing.border.Border), isBorderPainted(), setBorderPainted(boolean)

getUI

public ProgressBarUI getUI()

Возвращает объект темы отображения, который отрисовывает этот компонент.

Возвращает:

объект ProgressBarUI, который отрисовывает этот компонент

setUI

public void setUI(ProgressBarUI ui)

Устанавливает объект темы отображения, который отрисовывает этот компонент.

Параметры:

ui - объект ProgressBarUI

См. также:

UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

Сбрасывает свойство UI на значение, взятое из текущей темы отображения.

Переопределяет:

updateUI в классе JComponent

См. также:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Возвращает имя класса темы отображения, который отрисовывает этот компонент.

Переопределяет:

getUIClassID в классе JComponent

Возвращает:

строку "ProgressBarUI"

См. также:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

createChangeListener

protected ChangeListener createChangeListener()

Подклассы, которые хотят обрабатывать события изменения от модели по-другому, могут переопределить этот метод, чтобы вернуть экземпляр пользовательской реализации ChangeListener. По умолчанию ChangeListener просто вызывает метод fireStateChanged для передачи событий ChangeEvent слушателям ChangeListener, которые были добавлены непосредственно к полосе прогресса.

См. также:

changeListener, fireStateChanged(), ChangeListener, BoundedRangeModel

addChangeListener

public void addChangeListener(ChangeListener l)

Добавляет указанный ChangeListener к полосе прогресса.

Параметры:

l - ChangeListener для добавления

removeChangeListener

public void removeChangeListener(ChangeListener l)

Удаляет ChangeListener из полосы прогресса.

Параметры:

l - ChangeListener для удаления

getChangeListeners

public ChangeListener[] getChangeListeners()

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

Возвращает:

все добавленные ChangeListener или пустой массив, если слушатели не были добавлены

С:

1.4

fireStateChanged

protected void fireStateChanged()

См. также:

addChangeListener(javax.swing.event.ChangeListener), EventListenerList

getModel

public BoundedRangeModel getModel()

Возвращает модель данных, используемую этой полосой прогресса.

Возвращает:

текущую BoundedRangeModel

См. также:

setModel(javax.swing.BoundedRangeModel), BoundedRangeModel

setModel

public void setModel(BoundedRangeModel newModel)

Устанавливает модель данных, используемую JProgressBar. Обратите внимание, что BoundedRangeModel extent не используется и устанавливается в 0.

Параметры:

newModel - используемая BoundedRangeModel

getValue

public int getValue()

Возвращает текущее значение полосы прогресса из BoundedRangeModel. Значение всегда находится в пределах от минимального до максимального включительно.

Возвращает:

текущее значение полосы прогресса

См. также:

setValue(int), BoundedRangeModel.getValue()

getMinimum

public int getMinimum()

Возвращает минимальное значение полосы прогресса из BoundedRangeModel.

Возвращает:

минимальное значение полосы прогресса

См. также:

setMinimum(int), BoundedRangeModel.getMinimum()

getMaximum

public int getMaximum()

Возвращает максимальное значение полосы прогресса из BoundedRangeModel.

Возвращает:

максимальное значение полосы прогресса

См. также:

setMaximum(int), BoundedRangeModel.getMaximum()

setValue

public void setValue(int n)

Параметры:

n - новое значение

См. также:

getValue(), addChangeListener(javax.swing.event.ChangeListener), BoundedRangeModel.setValue(int)

setMinimum

public void setMinimum(int n)

Параметры:

n - новое минимальное значение

См. также:

getMinimum(), addChangeListener(javax.swing.event.ChangeListener), BoundedRangeModel.setMinimum(int)

setMaximum

public void setMaximum(int n)

Параметры:

n - новое максимальное значение

См. также:

getMaximum(), addChangeListener(javax.swing.event.ChangeListener), BoundedRangeModel.setMaximum(int)

setIndeterminate

public void setIndeterminate(boolean newValue)

Параметры:

newValue - true если полоса прогресса должна перейти в неопределенный режим; false если она должна вернуться к нормальному режиму.

С:

1.4

См. также:

isIndeterminate(), BasicProgressBarUI

isIndeterminate

public boolean isIndeterminate()

Возвращает значение свойства indeterminate.

Возвращает:

значение свойства indeterminate

С:

1.4

См. также:

setIndeterminate(boolean)

paramString

protected String paramString()

Возвращает строковое представление этого JProgressBar. Этот метод предназначен только для отладки. Содержание и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не может быть null.

Переопределяет:

paramString в классе JComponent

Возвращает:

строковое представление этого JProgressBar

getAccessibleContext

public AccessibleContext getAccessibleContext()

Получает AccessibleContext, связанное с этим JProgressBar. Для полос прокрутки AccessibleContext представлено в виде AccessibleJProgressBar. Новый экземпляр AccessibleJProgressBar создаётся при необходимости.

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

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

Переопределяет:

getAccessibleContext в классе Component

Возвращает:

объект AccessibleJProgressBar, который является AccessibleContext этого JProgressBar