Spec-Zone.ru › OpenJDK 17

Класс 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
Базовый класс для всех делегатов пользовательского интерфейса в архитектуре Swing с подключаемым внешним видом. Делегат пользовательского интерфейса для компонента Swing отвечает за реализацию аспектов компонента, которые зависят от внешнего вида. Класс JComponent вызывает методы из этого класса для делегирования операций (рисования, расчета макета и т. д.), которые могут меняться в зависимости от установленного внешнего вида. Клиентские программы не должны вызывать методы этого класса напрямую.
См. также:
  • JComponent
  • UIManager

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

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

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

Модификатор и тип Метод Описание
boolean contains(JComponent c, int x, int y)
Возвращает true, если указанные координаты x,y находятся в пределах заданной формы внешнего вида указанного компонента.
static ComponentUI createUI(JComponent c)
Возвращает экземпляр делегата пользовательского интерфейса для указанного компонента.
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)
Уведомляет этот делегат пользовательского интерфейса о том, что пришло время отобразить указанный компонент.

Методы, объявленные в классе 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. Установка клавиатурного UI (мнемоники, перемещение и т.д.) на компоненте.
  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, установленных UI, в компоненте.
  6. Сброс всех выделенных объектов данных экземпляра для возможности GC.
Параметры:
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 определены относительно системы координат указанного компонента. Хотя область компонента ограничена прямоугольником, этот метод предоставляет способ определения непрямоугольной формы в этих пределах для целей обнаружения нажатия.
Параметры:
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, этот метод должен вернуть количество дочерних элементов этого объекта. Графические интерфейсы могут захотеть переопределить этот метод, если они представляют области на экране, которые можно рассматривать как компоненты, но фактические компоненты не используются для представления этих областей. Примечание: начиная с версии 1.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 дочерний элемент объекта. Графические интерфейсы могут захотеть переопределить этот метод, если они представляют области на экране, которые можно рассматривать как компоненты, но фактические компоненты не используются для представления этих областей.

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

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

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

Spec-Zone.ru

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