Spec-Zone.ru › OpenJDK 21

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

uninstallUI

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

paint

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

update

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

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

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

getPreferredSize

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

getMinimumSize

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

getMaximumSize

public Dimension getMaximumSize(JComponent c)
Возвращает максимальный размер указанного компонента, соответствующий внешнему виду и ощущениям. Если возвращается null, максимальный размер будет рассчитан менеджером компоновки компонента вместо этого (это предпочтительный подход для любого компонента со специально установленным менеджером компоновки). Реализация этого метода по умолчанию вызывает getPreferredSize и возвращает это значение.
Параметры:
c - компонент, максимальный размер которого нужно запросить; этот аргумент часто игнорируется, но может использоваться, если объект UI является бессостоятельным и используется несколькими компонентами
Возвращает:
объект 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; этот аргумент часто игнорируется, но может использоваться, если объект UI является бессостоятельным и используется несколькими компонентами
x - координата x точки
y - координата y точки
Возвращает:
true если указанное положение x,y находится внутри заданной формы внешнего вида и ощущений для данного компонента
См. также:
  • JComponent.contains(int, int)
  • Component.contains(int, int)

createUI

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

getBaseline

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

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

Parameters:
c - JComponent запрашивается базовая линия
width - ширина для получения базовой линии
height - высота для получения базовой линии
Returns:
базовая линия или значение < 0, указывающее, что разумной базовой линии нет
Throws:
NullPointerException - если c равно null
IllegalArgumentException - если ширина или высота меньше 0
Since:
1.6
See Also:
  • JComponent.getBaseline(int,int)

getBaselineResizeBehavior

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

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

Parameters:
c - JComponent для возврата поведения изменения размера базовой линии
Returns:
перечисление, указывающее, как изменяется базовая линия при изменении размера компонента
Throws:
NullPointerException - если c равно null
Since:
1.6
See Also:
  • JComponent.getBaseline(int, int)

getAccessibleChildrenCount

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

getAccessibleChild

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

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

Parameters:
c - объект, для которого запрашивается дочерний элемент
i - индекс дочернего элемента (от нуля)
Returns:
i-й Accessible дочерний элемент объекта
See Also:
  • getAccessibleChildrenCount(javax.swing.JComponent)

© 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/ComponentUI.html

Spec-Zone.ru

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