Класс JOptionPane

@JavaBean(defaultProperty="UI",
          description="A component which implements standard dialog box controls.")
public class JOptionPane
extends JComponent
implements Accessible

JOptionPane упрощает вывод стандартного диалогового окна, которое запрашивает у пользователя значение или сообщает ему о чём-либо. Для получения информации об использовании JOptionPane, см. Как создать диалоговые окна, раздел в Руководстве по Java.

Хотя класс JOptionPane может показаться сложным из-за большого количества методов, практически все его использования сводятся к однострочным вызовам статических методов showXxxDialog методов, показанных ниже:

Имя метода	Описание
showConfirmDialog	Задает вопрос подтверждения, например, да/нет/отмена.
showInputDialog	Запрос ввода данных.
showMessageDialog	Сообщает пользователю о произошедшем событии.
showOptionDialog	Объединение вышеперечисленных трёх методов.

Каждый из этих методов также имеет вариант showInternalXXX использующий внутреннюю рамку для размещения диалогового окна (см. JInternalFrame). Также определены несколько удобных методов - перегруженные версии базовых методов, использующие различные списки параметров.

Все диалоговые окна являются модальными. Каждый метод showXxxDialog блокирует вызывающий метод до завершения взаимодействия пользователя.

иконка	сообщение
	значение ввода
кнопки выбора

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

Параметры:
Параметры этих методов следуют согласованным шаблонам:

parentComponent

Определяет Component , который должен быть родителем этого диалогового окна. Он используется двумя способами: Frame , содержащий его, используется в качестве Frame родителя для диалогового окна, а его экранные координаты используются для размещения диалогового окна. Как правило, диалоговое окно размещается непосредственно под компонентом. Этот параметр может быть null, в этом случае используется Frame по умолчанию, и диалоговое окно будет центрировано на экране (в зависимости от L&F).

сообщение

Описательное сообщение, которое будет размещено в диалоговом окне. В наиболее распространённом случае сообщение представляет собой просто String или String константу. Однако тип этого параметра фактически Object. Его интерпретация зависит от его типа:

Object[]

Массив объектов интерпретируется как серия сообщений (по одному на объект), расположенных вертикально друг под другом. Интерпретация рекурсивна - каждый объект в массиве интерпретируется в соответствии с его типом.

Component

Component отображается в диалоговом окне.

Icon

Icon обернут в JLabel и отображается в диалоговом окне.

другие

Объект преобразуется в String путём вызова его метода toString . Результат обернут в JLabel и отображается.

типСообщения

Определяет стиль сообщения. Менеджер внешнего вида может выводить диалоговое окно по-разному в зависимости от этого значения и часто предоставляет значок по умолчанию. Возможные значения:

• ERROR_MESSAGE
• INFORMATION_MESSAGE
• WARNING_MESSAGE
• QUESTION_MESSAGE
• PLAIN_MESSAGE

типОпций

Определяет набор кнопок выбора, которые отображаются в нижней части диалогового окна:

• DEFAULT_OPTION
• YES_NO_OPTION
• YES_NO_CANCEL_OPTION
• OK_CANCEL_OPTION

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

options

Более подробное описание набора кнопок выбора, которые отобразятся в нижней части диалогового окна. Обычно значение параметра options - массив String . Но тип параметра - массив Objects. Для каждого объекта создается кнопка в зависимости от его типа:

Component

Компонент добавляется в строку кнопок непосредственно.

Icon

Создается JButton с этим как подписью.

other

Object преобразуется в строку с помощью метода toString , а результат используется для обозначения JButton.

иконка

Декоративная иконка, которая должна быть размещена в диалоговом окне. Значение по умолчанию определяется параметром messageType .

заголовок

Заголовок диалогового окна.

начальноеЗначение

Значение по умолчанию (значение ввода).

При изменении выбора вызывается setValue , который генерирует PropertyChangeEvent.

Если JOptionPane настроен для всех входных setWantsInput , связанное свойство JOptionPane.INPUT_VALUE_PROPERTY также можно отслеживать, чтобы определить, когда пользователь ввел или выбрал значение.

Когда один из методов showXxxDialog возвращает целое число, возможные значения:

• YES_OPTION
• NO_OPTION
• CANCEL_OPTION
• OK_OPTION
• CLOSED_OPTION

Примеры:

Показать диалоговое окно об ошибке, отображающее сообщение 'ошибка':

JOptionPane.showMessageDialog(null, "alert", "alert", JOptionPane.ERROR_MESSAGE);

Показать диалоговое окно с информацией в виде внутреннего диалога с сообщением 'информация':

JOptionPane.showInternalMessageDialog(frame, "information",
             "information", JOptionPane.INFORMATION_MESSAGE);

Показать информационную панель с опциями да/нет и сообщением 'выберите один':

JOptionPane.showConfirmDialog(null,
             "choose one", "choose one", JOptionPane.YES_NO_OPTION);

Показать информационное диалоговое окно со внутренними опциями да/нет/отмена, сообщением 'пожалуйста выберите один' и заголовком 'информация':

JOptionPane.showInternalConfirmDialog(frame,
             "please choose one", "information",
             JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.INFORMATION_MESSAGE);

Показать диалоговое окно с предупреждением с опциями OK, ОТМЕНА, заголовком 'Предупреждение' и сообщением 'Нажмите OK, чтобы продолжить':

Object[] options = { "OK", "CANCEL" };
 JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
             JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE,
             null, options, options[0]);

Показать диалоговое окно, просящее пользователя ввести строку:

String inputValue = JOptionPane.showInputDialog("Please input a value");

Показать диалоговое окно, просящее пользователя выбрать строку:

Object[] possibleValues = { "First", "Second", "Third" };
 Object selectedValue = JOptionPane.showInputDialog(null,
             "Choose one", "Input",
             JOptionPane.INFORMATION_MESSAGE, null,
             possibleValues, possibleValues[0]);

Прямое использование:
Чтобы создать и использовать JOptionPane напрямую, стандартный шаблон примерно такой:

JOptionPane pane = new JOptionPane(arguments);
     pane.set.Xxxx(...); // Configure
     JDialog dialog = pane.createDialog(parentComponent, title);
     dialog.show();
     Object selectedValue = pane.getValue();
     if(selectedValue == null)
       return CLOSED_OPTION;
     //If there is not an array of option buttons:
     if(options == null) {
       if(selectedValue instanceof Integer)
          return ((Integer)selectedValue).intValue();
       return CLOSED_OPTION;
     }
     //If there is an array of option buttons:
     for(int counter = 0, maxCounter = options.length;
        counter < maxCounter; counter++) {
        if(options[counter].equals(selectedValue))
        return counter;
     }
     return CLOSED_OPTION;

Предупреждение: Swing не потокобезопасен. Более подробную информацию см. в Политике потоков Swing.

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