Spec-Zone.ru › OpenJDK 25

Класс BasicOptionPaneUI

java.lang.Object
javax.swing.plaf.ComponentUI
javax.swing.plaf.OptionPaneUI
javax.swing.plaf.basic.BasicOptionPaneUI
Прямые известные подклассы:
SynthOptionPaneUI
public class BasicOptionPaneUI extends OptionPaneUI
Предоставляет базовый стиль оформления для JOptionPane. BasicMessagePaneUI предоставляет возможность разместить значок, сообщение и кнопки в Container. Обычно расположение выглядит так: 
       ------------------
       | i | message    |
       | c | message    |
       | o | message    |
       | n | message    |
       ------------------
       |     buttons    |
       |________________|
значок представляет собой экземпляр Icon, обёрнутый в JLabel. Сообщение является непрозрачным объектом и проверяется следующим образом: если сообщение — это Component, оно добавляется в Container; если это Icon, оно оборачивается в JLabel и добавляется в Container; в противном случае оно оборачивается в JLabel.

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

Container, сообщение, значок и кнопки определяются абстрактными методами.

Краткое описание вложенных классов

Модификатор и тип Класс Описание
class  BasicOptionPaneUI.ButtonActionListener
Этот класс следует рассматривать как вложенный класс с модификатором "protected".
static class  BasicOptionPaneUI.ButtonAreaLayout
ButtonAreaLayout ведёт себя аналогично FlowLayout.
class  BasicOptionPaneUI.PropertyChangeHandler
Этот класс следует рассматривать как вложенный класс с модификатором "protected".

Краткое описание полей

Модификатор и тип Поле Описание
protected boolean hasCustomComponents
В validateComponent этому полю присваивается значение true, если сообщение или кнопки содержат компонент.
protected Component initialFocusComponent
Компонент, который получает фокус при вызове selectInitialValue.
protected JComponent inputComponent
JComponent, обеспечивающий ввод, если optionPane.getWantsInput() возвращает true.
static final int MinimumHeight
Минимальная высота JOptionPane.
protected Dimension minimumSize
Размер JOptionPane.
static final int MinimumWidth
Минимальная ширина JOptionPane.
protected JOptionPane optionPane
JOptionPane, для которого данный объект предоставляет стиль оформления.
protected PropertyChangeListener propertyChangeListener
Экземпляр PropertyChangeListener.

Краткое описание конструкторов

Конструктор Описание
BasicOptionPaneUI()
Создаёт BasicOptionPaneUI.

Краткое описание методов

Модификатор и тип Метод Описание
protected void addButtonComponents(Container container, Object[] buttons, int initialIndex)
Создаёт подходящий объект для представления каждого объекта из buttons и добавляет его в container.
protected void addIcon(Container top)
Создаёт JLabel, представляющий значок, полученный из getIcon, и добавляет его в top.
protected void addMessageComponents(Container container, GridBagConstraints cons, Object msg, int maxll, boolean internallyCreated)
Создаёт подходящий объект для представления msg и помещает его в container.
protected void burstStringInto(Container c, String d, int maxll)
Рекурсивно создаёт новые экземпляры JLabel для представления d.
boolean containsCustomComponents(JOptionPane op)
Возвращает true, если при последнем вызове validateComponent сообщение или кнопки содержали подкласс Component.
protected ActionListener createButtonActionListener(int buttonIndex)
Создаёт новый экземпляр ButtonActionListener.
protected Container createButtonArea()
Создаёт и возвращает Container, содержащий кнопки.
protected LayoutManager createLayoutManager()
Возвращает менеджер компоновки.
protected Container createMessageArea()
Вызывается из installComponents для создания Container, содержащего текст сообщения.
protected PropertyChangeListener createPropertyChangeListener()
Возвращает экземпляр PropertyChangeListener.
protected Container createSeparator()
Возвращает разделитель.
static ComponentUI createUI(JComponent x)
Создаёт новый экземпляр BasicOptionPaneUI.
protected Object[] getButtons()
Возвращает кнопки для отображения из JOptionPane, для которого данный объект предоставляет стиль оформления.
protected Icon getIcon()
Возвращает значок из JOptionPane, для которого данный объект предоставляет стиль оформления, или значок по умолчанию, возвращаемый getDefaultIcon.
protected Icon getIconForType(int messageType)
Возвращает значок для указанного типа.
protected int getInitialValueIndex()
Возвращает начальный индекс кнопки, которую следует выбрать.
protected int getMaxCharactersPerLineCount()
Возвращает максимальное число символов в строке.
protected Object getMessage()
Возвращает сообщение для отображения из JOptionPane, для которого данный объект предоставляет стиль оформления.
Dimension getMinimumOptionPaneSize()
Возвращает минимальный размер панели параметров.
Dimension getPreferredSize(JComponent c)
Если c — это JOptionPane, в котором находится данный объект, возвращаемый предпочтительный размер равен максимуму предпочтительного размера LayoutManager для JOptionPane и getMinimumOptionPaneSize.
protected boolean getSizeButtonsToSameWidth()
Возвращает true; базовый стиль оформления требует, чтобы все кнопки имели одинаковую ширину.
protected void installComponents()
Регистрирует компоненты.
protected void installDefaults()
Устанавливает свойства по умолчанию.
protected void installKeyboardActions()
Регистрирует действия клавиатуры.
protected void installListeners()
Регистрирует слушателей.
void installUI(JComponent c)
Устанавливает данный объект в качестве стиля оформления для переданного JOptionPane.
protected void resetInputValue()
Устанавливает значение ввода в панели параметров, для которой данный объект предоставляет стиль оформления, на основе значения в inputComponent.
void selectInitialValue(JOptionPane op)
Если inputComponent не равен null, фокус запрашивается для него; в противном случае фокус запрашивается для значения по умолчанию.
protected void uninstallComponents()
Отменяет регистрацию компонентов.
protected void uninstallDefaults()
Удаляет свойства по умолчанию.
protected void uninstallKeyboardActions()
Отменяет регистрацию действий клавиатуры.
protected void uninstallListeners()
Отменяет регистрацию слушателей.
void uninstallUI(JComponent c)
Удаляет данный объект из контроллера стиля оформления переданной разделённой панели.

Методы, объявленные в классе ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, paint, update

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

MinimumWidth

public static final int MinimumWidth
Минимальная ширина JOptionPane.
См. также:
  • Значения константных полей

MinimumHeight

public static final int MinimumHeight
Минимальная высота JOptionPane.
См. также:
  • Значения константных полей

optionPane

protected JOptionPane optionPane
JOptionPane, для которого данный объект предоставляет стиль оформления.

minimumSize

protected Dimension minimumSize
Размер JOptionPane.

inputComponent

protected JComponent inputComponent
JComponent, обеспечивающий ввод, если optionPane.getWantsInput() возвращает true.

initialFocusComponent

protected Component initialFocusComponent
Компонент, который получает фокус при вызове selectInitialValue.

hasCustomComponents

protected boolean hasCustomComponents
В validateComponent этому полю присваивается значение true, если сообщение или кнопки содержат компонент.

propertyChangeListener

protected PropertyChangeListener propertyChangeListener
Экземпляр PropertyChangeListener.

Подробное описание конструкторов

BasicOptionPaneUI

public BasicOptionPaneUI()
Создаёт BasicOptionPaneUI.

Подробное описание методов

createUI

public static ComponentUI createUI(JComponent x)
Создаёт новый экземпляр BasicOptionPaneUI.
Параметры:
x — компонент
Возвращает:
новый экземпляр BasicOptionPaneUI

installUI

public void installUI(JComponent c)
Устанавливает данный объект в качестве стиля оформления для переданного JOptionPane.
Переопределяет:
installUI в классе ComponentUI
Параметры:
c — компонент, для которого устанавливается этот делегат пользовательского интерфейса
См. также:
  • ComponentUI.uninstallUI(JComponent)
  • JComponent.setUI(ComponentUI)
  • JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)
Удаляет данный объект из контроллера стиля оформления переданной разделённой панели.
Переопределяет:
uninstallUI в классе ComponentUI
Параметры:
c — компонент, из которого удаляется этот делегат пользовательского интерфейса; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса не имеет состояния и совместно используется несколькими компонентами
См. также:
  • ComponentUI.installUI(JComponent)
  • JComponent.updateUI()

installDefaults

protected void installDefaults()
Устанавливает свойства по умолчанию.

uninstallDefaults

protected void uninstallDefaults()
Удаляет свойства по умолчанию.

installComponents

protected void installComponents()
Регистрирует компоненты.

uninstallComponents

protected void uninstallComponents()
Отменяет регистрацию компонентов.

createLayoutManager

protected LayoutManager createLayoutManager()
Возвращает менеджер компоновки.
Возвращает:
менеджер компоновки

installListeners

protected void installListeners()
Регистрирует слушателей.

uninstallListeners

protected void uninstallListeners()
Отменяет регистрацию слушателей.

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()
Возвращает экземпляр PropertyChangeListener.
Возвращает:
экземпляр PropertyChangeListener

installKeyboardActions

protected void installKeyboardActions()
Регистрирует действия клавиатуры.

uninstallKeyboardActions

protected void uninstallKeyboardActions()
Отменяет регистрацию действий клавиатуры.

getMinimumOptionPaneSize

public Dimension getMinimumOptionPaneSize()
Возвращает минимальный размер панели параметров. Предназначен главным образом для подклассов, которым требуется задать другой минимальный размер.
Возвращает:
минимальный размер панели параметров

getPreferredSize

public Dimension getPreferredSize(JComponent c)
Если c — это JOptionPane, в котором находится данный объект, возвращаемый предпочтительный размер равен максимуму предпочтительного размера LayoutManager для JOptionPane и getMinimumOptionPaneSize.
Переопределяет:
getPreferredSize в классе ComponentUI
Параметры:
c — компонент, предпочтительный размер которого запрашивается; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса не имеет состояния и совместно используется несколькими компонентами
Возвращает:
объект Dimension, содержащий предпочтительный размер указанного компонента, соответствующий стилю оформления
См. также:
  • JComponent.getPreferredSize()
  • LayoutManager.preferredLayoutSize(Container)

createMessageArea

protected Container createMessageArea()
Вызывается из installComponents для создания Container, содержащего текст сообщения. Значок создаётся вызовом addIcon.
Возвращает:
экземпляр Container

addMessageComponents

protected void addMessageComponents(Container container, GridBagConstraints cons, Object msg, int maxll, boolean internallyCreated)
Создаёт подходящий объект для представления msg и помещает его в container. Если msg является экземпляром Component, он добавляется напрямую; если это Icon, для его представления создаётся JLabel; в противном случае для строки создаётся JLabel. Если msg — это Object[], этот метод рекурсивно вызывается для дочерних элементов. internallyCreated имеет значение true, если msg является экземпляром Component и был создан этим методом (это позволяет правильно задавать hasCustomComponents только в том случае, если internallyCreated имеет значение false).
Параметры:
container — контейнер
cons — экземпляр GridBagConstraints
msg — сообщение
maxll — максимальная длина
internallyCreated — true, если компонент создан внутри метода

getMessage

protected Object getMessage()
Возвращает сообщение для отображения из JOptionPane, для которого данный объект предоставляет стиль оформления.
Возвращает:
сообщение для отображения

addIcon

protected void addIcon(Container top)
Создаёт JLabel, представляющий значок, полученный из getIcon, и добавляет его в top. Этот метод вызывается из createMessageArea.
Параметры:
top — контейнер

getIcon

protected Icon getIcon()
Возвращает значок из JOptionPane, для которого данный объект предоставляет стиль оформления, или значок по умолчанию, возвращаемый getDefaultIcon.
Возвращает:
значок

getIconForType

protected Icon getIconForType(int messageType)
Возвращает значок для указанного типа.
Параметры:
messageType — тип сообщения
Возвращает:
значок для указанного типа

getMaxCharactersPerLineCount

protected int getMaxCharactersPerLineCount()
Возвращает максимальное число символов в строке.
Возвращает:
максимальное число символов в строке

burstStringInto

protected void burstStringInto(Container c, String d, int maxll)
Рекурсивно создаёт новые экземпляры JLabel для представления d. Каждый экземпляр JLabel добавляется в c.
Параметры:
c — контейнер
d — текст
maxll — максимальная длина текста

createSeparator

protected Container createSeparator()
Возвращает разделитель.
Возвращает:
разделитель

createButtonArea

protected Container createButtonArea()
Создаёт и возвращает Container, содержащий кнопки. Кнопки создаются вызовом getButtons.
Возвращает:
Container, содержащий кнопки

addButtonComponents

protected void addButtonComponents(Container container, Object[] buttons, int initialIndex)
Создаёт подходящий объект для представления каждого объекта из buttons и добавляет его в container. Этот метод отличается от addMessageComponents тем, что рекурсивно обрабатывает buttons, а если кнопка не является Component, создаёт экземпляр JButton.
Параметры:
container — контейнер
buttons — массив кнопок
initialIndex — начальный индекс

createButtonActionListener

protected ActionListener createButtonActionListener(int buttonIndex)
Создаёт новый экземпляр ButtonActionListener.
Параметры:
buttonIndex — индекс кнопки
Возвращает:
новый экземпляр ButtonActionListener

getButtons

protected Object[] getButtons()
Возвращает кнопки для отображения из JOptionPane, для которого данный объект предоставляет стиль оформления. Если для JOptionPane заданы параметры, они будут предоставлены; в противном случае, если optionType имеет значение YES_NO_OPTION, возвращается yesNoOptions; если тип имеет значение YES_NO_CANCEL_OPTION, возвращается yesNoCancelOptions; иначе возвращаются defaultButtons.
Возвращает:
кнопки для отображения из JOptionPane

getSizeButtonsToSameWidth

protected boolean getSizeButtonsToSameWidth()
Возвращает true; базовый стиль оформления требует, чтобы все кнопки имели одинаковую ширину.
Возвращает:
true, если все кнопки должны иметь одинаковую ширину

getInitialValueIndex

protected int getInitialValueIndex()
Возвращает начальный индекс кнопки, которую следует выбрать. Индекс вычисляется на основе начального значения JOptionPane и его параметров либо равен 0.
Возвращает:
начальный индекс кнопки, которую следует выбрать

resetInputValue

protected void resetInputValue()
Устанавливает значение ввода в панели параметров, для которой данный объект предоставляет стиль оформления, на основе значения в inputComponent.

selectInitialValue

public void selectInitialValue(JOptionPane op)
Если inputComponent не равен null, фокус запрашивается для него; в противном случае фокус запрашивается для значения по умолчанию.
Указано в:
selectInitialValue в классе OptionPaneUI
Параметры:
op — JOptionPane

containsCustomComponents

public boolean containsCustomComponents(JOptionPane op)
Возвращает true, если при последнем вызове validateComponent сообщение или кнопки содержали подкласс Component.
Указано в:
containsCustomComponents в классе OptionPaneUI
Параметры:
op — JOptionPane
Возвращает:
true, если данный JOptionPane содержит созданные пользователем Components

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.desktop/javax/swing/plaf/basic/BasicOptionPaneUI.html

Spec-Zone.ru

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