Spec-Zone.ru › OpenJDK 21

Класс 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
Этот класс следует рассматривать как "защищенный" внутренний класс.
static class  BasicOptionPaneUI.ButtonAreaLayout
ButtonAreaLayout ведет себя аналогично FlowLayout.
class  BasicOptionPaneUI.PropertyChangeHandler
Этот класс следует рассматривать как "защищенный" внутренний класс.

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

Модификатор и тип Поле Описание
protected boolean hasCustomComponents
Устанавливается в значение true в validateComponent, если компонент содержится либо в сообщении, либо в кнопках.
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, базовый L&F хочет, чтобы все кнопки имели одинаковую ширину.
protected void installComponents()
Регистрирует компоненты.
protected void installDefaults()
Устанавливает свойства по умолчанию.
protected void installKeyboardActions()
Регистрирует действия клавиатуры.
protected void installListeners()
Регистрирует слушателей.
void installUI(JComponent c)
Устанавливает получателя в качестве L&F для переданной 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)
Удаляет получателя из контроллера L&F переданной разделительной панели.

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

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

Методы, объявленные в классе java.lang.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
Устанавливается в true в validateComponent, если компонент содержится как в сообщении, так и в кнопках.

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)
Устанавливает получателя в качестве L&F для переданного JOptionPane.
Переопределяет:
installUI в классе ComponentUI
Параметры:
c - компонент, в который устанавливается этот делегат UI
См. также:
  • ComponentUI.uninstallUI(javax.swing.JComponent)
  • JComponent.setUI(javax.swing.plaf.ComponentUI)
  • JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)
Удаляет получателя из контроллера L&F переданного разделительного раздела.
Переопределяет:
uninstallUI в классе ComponentUI
Параметры:
c - компонент, из которого удаляется этот делегат UI; этот аргумент часто игнорируется, но может использоваться, если объект UI является бессостоятельным и используется несколькими компонентами
См. также:
  • ComponentUI.installUI(javax.swing.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 - компонент, предпочтительный размер которого запрашивается; этот аргумент часто игнорируется, но может использоваться, если объект UI является бессостоятельным и используется несколькими компонентами
Возвращает:
объект Dimension содержащий предпочтительный размер заданного компонента, подходящий для внешнего вида
См. также:
  • JComponent.getPreferredSize()
  • LayoutManager.preferredLayoutSize(java.awt.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, он добавляется напрямую; если это строка, создаётся JLabel; в противном случае создаётся JLabel для строки. Если msg — массив объектов, этот метод будет рекурсивно вызван для дочерних элементов. 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.
Parameters:
c - контейнер
d - текст
maxll - максимальная длина текста

createSeparator

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

createButtonArea

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

addButtonComponents

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

createButtonActionListener

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

getButtons

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

getSizeButtonsToSameWidth

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

getInitialValueIndex

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

resetInputValue

protected void resetInputValue()
Устанавливает значение ввода в диалоговом окне (JOptionPane), для которого компонент предоставляет вид и ощущения, на основе значения в inputComponent.

selectInitialValue

public void selectInitialValue(JOptionPane op)
Если inputComponent не null, запрашивается фокус на нём, иначе на значении по умолчанию.
Specified by:
selectInitialValue в классе OptionPaneUI
Parameters:
op - a JOptionPane

containsCustomComponents

public boolean containsCustomComponents(JOptionPane op)
Возвращает true, если в последнем вызове validateComponent сообщение или кнопки содержали подкласс Component.
Specified by:
containsCustomComponents в классе OptionPaneUI
Parameters:
op - a JOptionPane
Returns:
true если данный JOptionPane содержит пользовательские Component

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

Spec-Zone.ru

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