Spec-Zone.ru › OpenJDK 24

Класс ComponentUI

java.lang.Object
javax.swing.plaf.ComponentUI
Прямые известные подклассы:
ButtonUI, ColorChooserUI, ComboBoxUI, DesktopIconUI, DesktopPaneUI, FileChooserUI, InternalFrameUI, LabelUI, LayerUI, ListUI, MenuBarUI, OptionPaneUI, PanelUI, PopupMenuUI, ProgressBarUI, RootPaneUI, ScrollBarUI, ScrollPaneUI, SeparatorUI, SliderUI, SpinnerUI, SplitPaneUI, TabbedPaneUI, TableHeaderUI, TableUI, TextUI, ToolBarUI, ToolTipUI, TreeUI, ViewportUI
public abstract class ComponentUI extends Object
Базовый класс для всех объектов-делегатов UI в архитектуре Swing, поддерживающей внешний вид. Объект-делегат UI для компонента Swing отвечает за реализацию аспектов компонента, зависящих от внешнего вида. Класс JComponent вызывает методы из этого класса для делегирования операций (рисования, расчета макета и т. д.), которые могут различаться в зависимости от установленного внешнего вида. Клиентские программы не должны вызывать методы этого класса напрямую.
См. также:
  • JComponent
  • UIManager

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

Конструктор Описание
ComponentUI()
Единственный конструктор.

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

Модификатор и тип Метод Описание
boolean contains(JComponent c, int x, int y)
Возвращает true, если указанные координаты x, y находятся в пределах определенной формой внешнего вида для указанного компонента.
static ComponentUI createUI(JComponent c)
Возвращает экземпляр делегата UI для указанного компонента.
Accessible getAccessibleChild(JComponent c, int i)
Возвращает i-й Accessible дочерний элемент объекта.
int getAccessibleChildrenCount(JComponent c)
Возвращает количество доступных дочерних элементов в объекте.
int getBaseline(JComponent c, int width, int height)
Возвращает базовую линию.
Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Возвращает перечисление, указывающее, как базовая линия компонента изменяется при изменении размера.
Dimension getMaximumSize(JComponent c)
Возвращает максимальный размер указанного компонента, соответствующий внешнему виду.
Dimension getMinimumSize(JComponent c)
Возвращает минимальный размер указанного компонента, соответствующий внешнему виду.
Dimension getPreferredSize(JComponent c)
Возвращает предпочтительный размер указанного компонента, соответствующий внешнему виду.
void installUI(JComponent c)
Настраивает указанный компонент в соответствии с внешним видом.
void paint(Graphics g, JComponent c)
Рисует указанный компонент в соответствии с внешним видом.
void uninstallUI(JComponent c)
Отменяет настройку, выполненную для указанного компонента во время installUI.
void update(Graphics g, JComponent c)
Уведомляет этот делегат UI о том, что пришло время нарисовать указанный компонент.

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

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

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

ComponentUI

public ComponentUI()
Единственный конструктор. (Для вызова конструкторами подклассов, обычно неявный).

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

installUI

public void installUI(JComponent c)
Настраивает указанный компонент в соответствии с внешним видом. Этот метод вызывается, когда экземпляр ComponentUI устанавливается в качестве делегата пользовательского интерфейса для указанного компонента. Этот метод должен полностью настроить компонент для внешнего вида, включая следующее:
  1. Установить значения свойств по умолчанию для цвета, шрифтов, границ, значков, непрозрачности и т. д. на компоненте. При возможности значения свойств, инициализированные программой клиента, не должны переопределяться.
  2. Установить LayoutManager на компоненте, если это необходимо.
  3. Создать/добавить любые необходимые подкомпоненты в компонент.
  4. Создать/установить обработчики событий на компоненте.
  5. Создать/установить PropertyChangeListener на компоненте для соответствующей обработки изменений свойств компонента.
  6. Установить пользовательский интерфейс клавиатуры (мнемоники, перемещение по элементам и т. д.) на компоненте.
  7. Инициализировать любые соответствующие данные экземпляра.
Параметры:
c - компонент, на котором устанавливается этот делегат пользовательского интерфейса
См. также:
  • uninstallUI(javax.swing.JComponent)
  • JComponent.setUI(javax.swing.plaf.ComponentUI)
  • JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)
Отменяет настройки, которые были выполнены на указанном компоненте во время installUI. Этот метод вызывается, когда этот экземпляр UIComponent удаляется в качестве делегата пользовательского интерфейса для указанного компонента. Этот метод должен отменить настройки, выполненные в installUI, тщательно сохраняя экземпляр JComponent в чистом состоянии (без лишних обработчиков, объектов свойств, специфичных для внешнего вида и т. д.). Это должно включать следующее:
  1. Удалить любые установленные внешним видом границы из компонента.
  2. Удалить любые установленные внешним видом менеджеры компоновки из компонента.
  3. Удалить любые добавленные внешним видом подкомпоненты из компонента.
  4. Удалить любые добавленные внешним видом обработчики событий/свойств из компонента.
  5. Удалить любой установленный внешним видом пользовательский интерфейс клавиатуры из компонента.
  6. Сделать нулевыми любые выделенные объекты данных экземпляра, чтобы разрешить сбор мусора.
Параметры:
c - компонент, из которого удаляется этот делегат пользовательского интерфейса; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
См. также:
  • installUI(javax.swing.JComponent)
  • JComponent.updateUI()

paint

public void paint(Graphics g, JComponent c)
Рисует указанный компонент в соответствии с внешним видом. Этот метод вызывается из метода ComponentUI.update, когда указанный компонент рисуется. Подклассы должны переопределять этот метод и использовать указанный объект Graphics для отрисовки содержимого компонента.
Параметры:
g - контекст Graphics для рисования
c - компонент, который рисуется; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
См. также:
  • update(java.awt.Graphics, javax.swing.JComponent)

update

public void update(Graphics g, JComponent c)
Уведомляет этот делегат пользовательского интерфейса о том, что пришло время нарисовать указанный компонент. Этот метод вызывается JComponent при отрисовке указанного компонента.

По умолчанию этот метод заполняет указанный компонент цветом фона, если его свойство opaque имеет значение true, а затем немедленно вызывает paint. Как правило, этот метод не нужно переопределять подклассам; весь код отрисовки внешнего вида должен находиться в методе paint.

Параметры:
g - контекст Graphics для рисования
c - компонент, который рисуется; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
См. также:
  • paint(java.awt.Graphics, javax.swing.JComponent)
  • JComponent.paintComponent(java.awt.Graphics)

getPreferredSize

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

getMinimumSize

public Dimension getMinimumSize(JComponent c)
Возвращает минимальный размер указанного компонента, соответствующий внешнему виду. Если возвращается null, минимальный размер будет вычислен менеджером компоновки компонента (это предпочтительный подход для любого компонента с установленным менеджером компоновки). По умолчанию этот метод вызывает getPreferredSize и возвращает это значение.
Параметры:
c - компонент, минимальный размер которого запрашивается; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
Возвращает:
объект Dimension или null
См. также:
  • JComponent.getMinimumSize()
  • LayoutManager.minimumLayoutSize(java.awt.Container)
  • getPreferredSize(javax.swing.JComponent)

getMaximumSize

public Dimension getMaximumSize(JComponent c)
Возвращает максимальный размер указанного компонента, соответствующий внешнему виду. Если возвращается null, максимальный размер будет вычислен менеджером компоновки компонента (это предпочтительный подход для любого компонента с установленным менеджером компоновки). По умолчанию этот метод вызывает getPreferredSize и возвращает это значение.
Параметры:
c - компонент, максимальный размер которого запрашивается; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
Возвращает:
объект Dimension или null
См. также:
  • JComponent.getMaximumSize()
  • LayoutManager2.maximumLayoutSize(java.awt.Container)

contains

public boolean contains(JComponent c, int x, int y)
Возвращает true, если указанное значение x,y находится внутри определенной формы внешнего вида указанного компонента. x и y определены как относительные к системе координат указанного компонента. Хотя bounds компонента ограничен прямоугольником, этот метод предоставляет средства для определения непрямоугольной формы в этих границах для целей обнаружения нажатий.
Параметры:
c - компонент, в котором запрашивается расположение x,y; этот аргумент часто игнорируется, но может использоваться, если объект пользовательского интерфейса является бессостоятельным и используется несколькими компонентами
x - координата x точки
y - координата y точки
Возвращает:
true, если указанное расположение x,y находится внутри определенной формы внешнего вида для данного компонента
См. также:
  • JComponent.contains(int, int)
  • Component.contains(int, int)

createUI

public static ComponentUI createUI(JComponent c)
Возвращает экземпляр делегата пользовательского интерфейса для указанного компонента. Каждый подкласс должен предоставить свой собственный статический createUI метод, возвращающий экземпляр подкласса этого делегата пользовательского интерфейса. Если подкласс делегата пользовательского интерфейса является бессостоятельным, он может вернуть экземпляр, используемый несколькими компонентами. Если делегат пользовательского интерфейса имеет состояние, он должен возвращать новый экземпляр для каждого компонента. По умолчанию этот метод вызывает ошибку, так как он никогда не должен вызываться.
Параметры:
c - a JComponent для которого нужно создать делегата пользовательского интерфейса
Возвращает:
объект ComponentUI для c

getBaseline

public int getBaseline(JComponent c, int width, int height)
Возвращает базовую линию. Базовая линия измеряется сверху компонента. Этот метод предназначен в основном для LayoutManager, чтобы выровнять компоненты по базовой линии. Значение возврата меньше 0 указывает, что у этого компонента нет разумной базовой линии, и что LayoutManager не должны выравнивать этот компонент по его базовой линии.

Этот метод возвращает -1. Подклассы, имеющие осмысленную базовую линию, должны переопределить её соответствующим образом.

Параметры:
c - JComponent базовой линии запрашивается для
width - ширина для получения базовой линии
height - высота для получения базовой линии
Возвращает:
базовую линию или значение < 0, указывающее, что разумной базовой линии нет
Исключения:
NullPointerException - если c равно null
IllegalArgumentException - если ширина или высота < 0
С:
1.6
См. также:
  • JComponent.getBaseline(int,int)

getBaselineResizeBehavior

public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Возвращает перечисление, указывающее, как базовая линия компонента изменяется при изменении размера. Этот метод предназначен в первую очередь для менеджеров компоновки и создателей графических интерфейсов.

Этот метод возвращает BaselineResizeBehavior.OTHER. Подклассы, поддерживающие базовую линию, должны переопределить её соответствующим образом.

Параметры:
c - JComponent для получения поведения изменения базовой линии
Возвращает:
перечисление, указывающее, как изменяется базовая линия при изменении размера компонента
Исключения:
NullPointerException - если c равно null
С:
1.6
См. также:
  • JComponent.getBaseline(int, int)

getAccessibleChildrenCount

public int getAccessibleChildrenCount(JComponent c)
Возвращает количество доступных дочерних элементов в объекте. Если все дочерние элементы этого объекта реализуют Accessible, этот метод должен вернуть количество дочерних элементов этого объекта. Интерфейсы могут захотеть переопределить этот метод, если они представляют на экране области, которые можно рассматривать как компоненты, но фактические компоненты не используются для представления этих областей. Примечание: начиная с версии 1.3, рекомендуется использовать Component.AccessibleAWTComponent.getAccessibleChildrenCount() вместо этого метода.
Параметры:
c - JComponent, для которого нужно получить количество доступных дочерних элементов
Возвращает:
количество доступных дочерних элементов в объекте
См. также:
  • getAccessibleChild(javax.swing.JComponent, int)

getAccessibleChild

public Accessible getAccessibleChild(JComponent c, int i)
Возвращает i-й Accessible дочерний элемент объекта. Интерфейсы могут потребоваться переопределить этот метод, если они представляют на экране области, которые можно рассматривать как компоненты, но фактические компоненты не используются для представления этих областей.

Примечание: начиная с версии 1.3, рекомендуется использовать Component.AccessibleAWTComponent.getAccessibleChild() вместо этого метода.

Параметры:
c - объект JComponent, для которого нужно получить дочерний объект
i - индекс дочернего элемента (нумерация с 0)
Возвращает:
i-й Accessible дочерний элемент объекта
См. также:
  • getAccessibleChildrenCount(javax.swing.JComponent)

© 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/plaf/ComponentUI.html

Spec-Zone.ru

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