Как Использовать Индикаторы выполнения

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

Другой способ указать на работу состоит в том, чтобы установить ожидать курсор, используя Cursor class и Component- определенный setCursor метод. Например, следующий код заставляет ожидать курсор быть выведенным на экран, когда курсор закончен container (включая любые компоненты это содержит, у которых нет никакого определенного курсора):

container.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));

Чтобы передать, насколько полный задача, можно использовать индикатор выполнения как этот:

Иногда невозможно сразу определить длину продолжительной задачи, или задача могла бы остаться упорно продолженной то же самое состояние завершения в течение долгого времени. Можно показать работу без измеримого продвижения, помещая индикатор выполнения в неопределенный режим. Индикатор выполнения в неопределенном режиме выводит на экран анимацию, чтобы указать, что работа происходит. Как только индикатор выполнения может вывести на экран больше значимой информации, следует переключить это назад в ее значение по умолчанию, определенный режим. В стили Java неопределенные индикаторы выполнения похожи на это:

Swing обеспечивает три класса, чтобы помочь Вам использовать индикаторы выполнения:

JProgressBar

Видимый компонент, чтобы графически вывести на экран, сколько из полной задачи завершилось. См. Используя Определенные Индикаторы выполнения для информации и примера использования типичного индикатора выполнения. Раздел Используя Неопределенный Режим говорит Вам, как анимировать индикатор выполнения, чтобы показать действие прежде, чем контекст задачи будет известен.

ProgressMonitor

Не видимый компонент. Вместо этого экземпляр этого class контролирует продвижение задачи и раскрывается диалоговое окно в случае необходимости. См., Как Использовать Мониторы Продвижения для деталей и примера использования монитора продвижения.

ProgressMonitorInputStream

Входной поток с присоединенным монитором продвижения, который контролирует чтение из потока. Вы используете экземпляр этого потока как любой из других входных потоков, описанных в Основном вводе-выводе. Можно получить монитор продвижения потока со звонком getProgressMonitor и сконфигурируйте это как описано в том, Как Использовать Мониторы Продвижения.

После того, как Вы видите, что индикатор выполнения и продвижение контролируют в действии, Решая, использовать Ли Индикатор выполнения, или Монитор Продвижения может помочь Вам выяснить, который является подходящим для Вашего приложения.

Используя Определенные Индикаторы выполнения

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

Ниже код от ProgressBarDemo.java это создает и устанавливает индикатор выполнения:

//Where member variables are declared:
JProgressBar progressBar;
...
//Where the GUI is constructed:
progressBar = new JProgressBar(0, task.getLengthOfTask());
progressBar.setValue(0);
progressBar.setStringPainted(true);

Конструктор, который создает индикатор выполнения, устанавливает минимальные и максимальные значения индикатора выполнения. Можно также установить эти значения с setMinimum и setMaximum. Минимальные и максимальные значения, используемые в этой программе, 0 и длина задачи, которая типична для многих программ и задач. Однако, минимальные и максимальные значения индикатора выполнения могут быть любым значением, даже отрицательным. Фрагмент кода также устанавливает текущую стоимость индикатора выполнения в 0.

Звонок setStringPainted заставляет индикатор выполнения выводить на экран, в пределах его границ, текстовой индикации относительно процента задачи, которая завершилась. По умолчанию индикатор выполнения выводит на экран значение, возвращенное getPercentComplete метод, отформатированный как процент, такой как 33 %. Альтернативно, можно заменить значение по умолчанию различной строкой, вызывая setString. Например,

if (/*...half way done...*/)
    progressBar.setString("Half way there!");

Когда пользовательские щелчки Запускаются, экземпляр внутреннего class Task создается и выполняется.

public void actionPerformed(ActionEvent evt) {
    startButton.setEnabled(false);
    setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
    done = false;
    task = new Task();
    task.addPropertyChangeListener(this);
    task.execute();
}

Task подкласс javax.swing.SwingWorker. Task экземпляр делает три важных вещи для ProgressBarDemo:

1. Экземпляр вызывает doInBackground в отдельном потоке. Это - то, где продолжительная задача фактически выполняется. Используя фоновый поток вместо диспетчеризирующего событие потока препятствует тому, чтобы пользовательский интерфейс заморозился, в то время как задача работает.
2. Когда фоновая задача полна, экземпляр вызывает done метод в диспетчеризирующем событие потоке.
3. Экземпляр поддерживает связанное свойство, progress, это обновляется, чтобы указать на продвижение задачи. propertyChange метод вызывается каждый раз progress изменения.

См. Рабочие потоки и SwingWorker в Параллелизме в Swing для получения дополнительной информации о SwingWorker.

Фоновая задача в ProgressBarDemo моделирует реальную задачу, сообщая о случайном количестве продвижения наугад интервалы. propertyChange метод отвечает на изменения в задача progress свойство, обновляя индикатор выполнения:

public void propertyChange(PropertyChangeEvent evt) {
    if (!done) {
        int progress = task.getProgress();
        progressBar.setValue(progress);
        taskOutput.append(String.format(
                "Completed %d%% of task.\n", progress));
    }

Когда фоновая задача полна, задача done метод сбрасывает индикатор выполнения:

public void done() {
    //Tell progress listener to stop updating progress bar.
    done = true;
    Toolkit.getDefaultToolkit().beep();
    startButton.setEnabled(true);
    setCursor(null); //turn off the wait cursor
    progressBar.setValue(progressBar.getMinimum());
    taskOutput.append("Done!\n");
}

Отметьте что done метод устанавливает done поле к true, предотвращение propertyChange от создания дальнейших обновлений к индикатору выполнения. Это необходимо, потому что финал обновляет к progress свойство может occcur после done вызывается.

Используя Неопределенный Режим

В ProgressBarDemo2 неопределенный режим устанавливается, пока фактическое продвижение не начинается:

public void propertyChange(PropertyChangeEvent evt) {
    if (!done) {
        int progress = task.getProgress();
        if (progress == 0) {
            progressBar.setIndeterminate(true);
            taskOutput.append("No progress yet\n");
        } else {
            progressBar.setIndeterminate(false); 
            progressBar.setString(null);
            progressBar.setValue(progress);
            taskOutput.append(String.format(
                    "Completed %d%% of task.\n", progress));
        }
    }
}

Другие изменения в коде связываются, чтобы представить дисплей в виде строки. Индикатор выполнения, который выводит на экран строку, вероятно, будет более высоким чем тот, который не делает, и, как демонстрационные разработчики, у нас есть arbitarily, решенный, что этот индикатор выполнения должен вывести на экран строку только, когда это находится в значении по умолчанию, определенном режиме. Однако, мы хотим избежать уродства расположения, которое могло бы закончиться, если индикатор выполнения измененный height, когда это изменило режимы. Таким образом, листы кода в звонке setStringPainted(true) но добавляет звонок setString("") так, чтобы никакой текст не был выведен на экран. Позже, когда индикатор выполнения переключается от неопределенного до определенного режима, вызывая setString(null) заставляет индикатор выполнения вывести на экран свою строку значения по умолчанию.

Одно изменение, которое мы не производили, удаляло звонок progressBar.setValue от progress обработчик событий. Вызов не делает ничего плохого, потому что неопределенный индикатор выполнения не использует свое свойство значения, кроме, возможно, чтобы вывести на экран его в строке состояния. Фактически, хранение данных индикатора выполнения, настолько актуальных насколько возможно, является хорошей практикой, так как некоторый взгляд и чувства не могли бы поддерживать неопределенный режим.

Как Использовать Мониторы Продвижения

Теперь давайте перепишем ProgressBarDemo, чтобы использовать монитор продвижения вместо индикатора выполнения. Вот изображение новой демонстрационной программы, ProgressMonitorDemo:

Монитор продвижения не может использоваться снова, таким образом, новый должен быть создан каждый раз запускается, когда новая задача. Эта программа создает монитор продвижения каждый раз, когда пользователь запускает новую задачу с кнопки Start.

Вот оператор, который создает монитор продвижения:

progressMonitor = new ProgressMonitor(ProgressMonitorDemo.this,
                                      "Running a Long Task",
                                      "", 0, task.getLengthOfTask());

Этот код использование ProgressMonitor's только конструктор, чтобы создать монитор и инициализировать несколько параметров:

• Первый параметр обеспечивает, родительский компонент к диалоговому окну раскрывался монитором продвижения.
• Вторым параметром является строка, которая описывает природу контролируемой задачи. Эта строка выводится на экран на диалоговом окне. см., Что Продвижение Контролирует API для деталей об этом параметре.
• Третьим параметром является другая строка, которая обеспечивает изменчивое примечание состояния. Пример использует пустую строку, чтобы указать, что диалоговое окно должно сделать пространство для изменчивого примечания состояния, но что примечание первоначально пусто. Если Вы обеспечиваете null для этого параметра примечание опускается от диалогового окна. Пример обновляет примечание каждый раз progress изменения свойства. Это обновляет текущую стоимость монитора одновременно:

  int progress = task.getProgress();
  String message = String.format("Completed %d%%.\n", progress);
  progressMonitor.setNote(message);
  progressMonitor.setProgress(progress);
  taskOutput.append(message);
  

• Последние два параметра обеспечивают минимальные и максимальные значения, соответственно, для индикатора выполнения, выведенного на экран в диалоговом окне.

По умолчанию монитор продвижения ожидает minium 500 миллисекунд прежде, чем решить, раскрыться ли диалоговое окно. Это также ожидает продвижения, чтобы стать больше чем минимальное значение. Если это вычисляет, что задача возьмет больше чем 2000 миллисекунд, чтобы завершиться, диалоговое окно продвижения появляется. Чтобы скорректировать минимальное время ожидания, вызвать setMillisToDecidedToPopup. Чтобы скорректировать минимальное время продвижения, требуемое для диалогового окна появиться, вызвать setMillisToPopup.

Очевидным фактом, что этот пример использует монитор продвижения, он добавляет опцию, которая не присутствовала в версии программы, которая использует индикатор выполнения: пользователь может отменить задачу, нажимая кнопку Cancel на диалоговом окне. Вот код в примере, который проверяет, чтобы видеть если пользователь, отмененный задача или если задача, из которой выходят обычно:

if (progressMonitor.isCanceled() || task.isDone()) {
    progressMonitor.close();
    Toolkit.getDefaultToolkit().beep();
    if (progressMonitor.isCanceled()) {
        task.cancel(true);
        taskOutput.append("Task canceled.\n");
    } else {
        taskOutput.append("Task completed.\n");
    }
    startButton.setEnabled(true);
}

Отметьте, что монитор продвижения самостоятельно не отменяет задачу. Это обеспечивает GUI и API, чтобы позволить программе делать так легко.

Решение, использовать Ли Индикатор выполнения или Монитор Продвижения

Используйте индикатор выполнения если:

• Вы хотите больше управления конфигурацией индикатора выполнения. Если Вы работаете непосредственно с индикатором выполнения, можно установить его, чтобы быть неопределенными, заставить его вывести на экран вертикально, обеспечить строку для него, чтобы вывести на экран, зарегистрировать слушателей изменения на нем, и предоставить ему ограниченную модель диапазона, чтобы управлять минимумом индикатора выполнения, максимумом, и текущей стоимостью.
• Программа должна вывести на экран другие компоненты наряду с индикатором выполнения.
• Вы нуждаетесь больше чем в одном индикаторе выполнения. С некоторыми задачами Вы должны контролировать больше чем один параметр. Например, программа установки могла бы контролировать использование дискового пространства в дополнение к тому, сколько файлов было успешно установлено.
• Вы должны снова использовать индикатор выполнения. Индикатор выполнения может быть снова использован; монитор продвижения не может. Как только монитор продвижения решил вывести на экран диалоговое окно (или не), монитор продвижения не может сделать этого снова.

Используйте монитор продвижения если:

• Вы хотите легкий способ вывести на экран продвижение диалогового окна.
• Выполняющаяся задача вторична, и пользователь не мог бы интересоваться продвижением задачи. Монитор продвижения обеспечивает способ для пользователя отклонить диалоговое окно, в то время как задача все еще работает.
• Вы хотите, чтобы легкий способ к задаче был отменен. Монитор продвижения предоставляет GUI пользователю, чтобы отменить задачу. Все, что необходимо сделать, вызвать монитор продвижения isCanceled метод, чтобы узнать, если пользователя, нажатого кнопка Cancel.
• Ваша задача периодически выводит на экран короткое сообщение, работая. Диалоговое окно монитора продвижения обеспечивает setNote метод так, чтобы задача могла обеспечить дополнительную информацию о том, что это делает. Например, задача установки могла бы сообщить об имени каждого файла, поскольку это устанавливается.
• Задача не могла бы занять много времени, чтобы завершиться. Вы решаете, в какой точке выполняющаяся задача занимает много времени достаточно, чтобы гарантировать сообщение пользователю об этом. Монитор продвижения не будет раскрываться диалоговое окно, если задача завершится в пределах периода времени, Вы устанавливаете.

Если Вы решаете использовать монитор продвижения и задачу, Вы контролируете, читает из входного потока, используйте ProgressMonitorInputStream class.

Контрольный API Продвижения

Следующие таблицы приводят обычно используемый API для того, чтобы использовать мониторы продвижения и индикаторы выполнения. Поскольку JProgressBar подкласс JComponent, другие методы Вы, вероятно, обратитесь к a JProgressBar перечисляются в Классе JComponent. Отметьте это ProgressMonitor подкласс Object и не визуальный компонент.

API для того, чтобы контролировать продвижение попадает в эти категории:

• Создание Индикатора выполнения
• Установка или Получение Ограничений/Значений Индикатора выполнения
• Управление Появлением Индикатора выполнения
• Создание Монитора Продвижения
• Конфигурирование Монитора Продвижения
• Завершение Монитора Продвижения

Примеры то Продвижение Монитора

Этот после использования в качестве примера JProgressBar или ProgressMonitor.

Если Вы программируете в JavaFX, см. Индикатор выполнения и Индикатор хода выполнения.