Spec-Zone.ru › OpenJDK 17

Класс BasicOptionPaneUI

java.lang.Object
javax.swing.plaf.ComponentUI
javax.swing.plaf.OptionPaneUI
javax.swing.plaf.basic.BasicOptionPaneUI
Direct Known Subclasses:
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.

Вышеупомянутый макет используется, когда свойство optionPane's 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, базовый вид и ощущения требуют, чтобы все кнопки имели одинаковую ширину.
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 переданного split pane.
Переопределяет:
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()
Возвращает минимальный размер option pane. Предоставляется в основном подклассам, желающим предложить другой минимальный размер.
Возвращает:
минимальный размер option pane

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 является массивом 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.
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, и если кнопка не является компонентом, создаёт экземпляр 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, стандартное визуальное оформление требует, чтобы все кнопки имели одинаковую ширину.
Returns:
true если все кнопки должны иметь одинаковую ширину

getInitialValueIndex

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

resetInputValue

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

selectInitialValue

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

containsCustomComponents

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

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

Spec-Zone.ru

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