Класс BasicTextUI

javax.swing.plaf.basic.BasicTextUI

Все реализованные интерфейсы:: ViewFactory

Прямые известные подклассы:: BasicEditorPaneUI, BasicTextAreaUI, BasicTextFieldUI, DefaultTextUI

public abstract class BasicTextUI extends TextUI implements ViewFactory

Основа внешнего вида текстовых компонентов. Обеспечивает базовые сервисы представления и управления редактированием, которые могут быть полезны при создании внешнего вида для расширения JTextComponent.

Большинство состояний хранятся в ассоциированном JTextComponent в качестве связанных свойств, и UI устанавливает значения по умолчанию для различных свойств. Это значение по умолчанию установит что-то для всех свойств. Обычно, реализация LAF выполняет больше действий. В минимальном случае, LAF обычно установит сочетания клавиш.

Этот класс также обеспечивает некоторую поддержку одновременного выполнения, если Document, связанное с JTextComponent, является подклассом AbstractDocument. Доступ к представлению (или иерархии представлений) сериализован между любым потоком, изменяющим модель, и потоком событий Swing (который, как ожидается, будет выполнять отрисовку, выполнять преобразование координат модель/представление и т. д.). Любой доступ к корневому представлению должен сначала получить блокировку чтения на AbstractDocument и освободить эту блокировку в блоке finally.

Важный метод для определения - метод getPropertyPrefix(), который используется в качестве основы для ключей, используемых для извлечения значений по умолчанию из UIManager. Строка должна отражать тип TextUI (например, TextField, TextArea и т. д.) без части имени, относящейся к конкретной LAF (например, Metal, Motif и т. д.).

Для построения представления модели можно использовать одну из следующих стратегий.

Одна стратегия состоит в простом переопределении интерфейса ViewFactory в UI. По умолчанию, этот UI сам выступает в качестве фабрики для реализаций View. Это полезно для простых фабрик. Для этого переопределите метод create(javax.swing.text.Element).
Общей стратегией для создания более сложных типов документов является использование реализации EditorKit для возврата фабрики. Поскольку EditorKit связывает все необходимые компоненты для поддержания типа документа, фабрика обычно является важной частью этого и должна быть создана реализацией EditorKit.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans была добавлена в пакет java.beans. Обратитесь к XMLEncoder.

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static class`	`BasicTextUI.BasicCaret`	Базовое реализация интерфейса `Caret`.
`static class`	`BasicTextUI.BasicHighlighter`	Базовое реализация интерфейса `Highlighter`.

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

Конструктор	Описание
`BasicTextUI()`	Создает новый интерфейс пользователя.

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

Модификатор и тип	Метод	Описание
`View`	`create(Element elem)`	Создает представление для элемента.
`View`	`create(Element elem, int p0, int p1)`	Создает представление для элемента.
`protected Caret`	`createCaret()`	Создает объект для курсора.
`protected Highlighter`	`createHighlighter()`	Создает объект для добавления выделений.
`protected Keymap`	`createKeymap()`	Создает мапу клавиш для текстового компонента и устанавливает необходимые привязки.
`void`	`damageRange(JTextComponent tc, int p0, int p1)`	Перерисовывает часть представления, отвечающую за указанную часть модели.
`void`	`damageRange(JTextComponent t, int p0, int p1, Position.Bias p0Bias, Position.Bias p1Bias)`	Перерисовывает часть представления, отвечающую за указанную часть модели.
`protected final JTextComponent`	`getComponent()`	Возвращает текстовый компонент, связанный с этим представлением UI.
`EditorKit`	`getEditorKit(JTextComponent tc)`	Возвращает EditorKit для интерфейса пользователя.
`protected String`	`getKeymapName()`	Возвращает имя мапы клавиш, которая будет установлена/использоваться по умолчанию для этого интерфейса пользователя.
`Dimension`	`getMaximumSize(JComponent c)`	Получает максимальный размер компонента редактора.
`Dimension`	`getMinimumSize(JComponent c)`	Получает минимальный размер компонента редактора.
`int`	`getNextVisualPositionFrom(JTextComponent t, int pos, Position.Bias b, int direction, Position.Bias[] biasRet)`	Предоставляет способ определения следующего визуально представленного местоположения модели, в которое можно поместить курсор.
`Dimension`	`getPreferredSize(JComponent c)`	Получает предпочтительный размер компонента редактора.
`protected abstract String`	`getPropertyPrefix()`	Получает имя, используемое в качестве ключа для поиска свойств через UIManager.
`View`	`getRootView(JTextComponent tc)`	Получает представление с выделением связанного текстового компонента (т.е. корень иерархии), которое можно пройти для определения того, как модель представлена в пространстве.
`String`	`getToolTipText(JTextComponent t, Point pt)`	Возвращает строку, которая будет использоваться в качестве всплывающей подсказки в указанном местоположении.
`protected Rectangle`	`getVisibleEditorRect()`	Получает выделение для корневого представления.
`protected void`	`installDefaults()`	Инициализирует свойства компонента, такие как шрифт, цвет переднего плана, цвет фона, цвет курсора, цвет выделения, цвет выделенного текста, цвет отключенного текста, граница и отступ.
`protected void`	`installKeyboardActions()`	Регистрирует действия с клавиатуры.
`protected void`	`installListeners()`	Устанавливает слушатели для интерфейса пользователя.
`void`	`installUI(JComponent c)`	Устанавливает интерфейс пользователя для компонента.
`protected void`	`modelChanged()`	Помечает изменения модели.
`Rectangle`	`modelToView(JTextComponent tc, int pos)`	Устаревший. заменен на `TextUI.modelToView2D(JTextComponent, int, Position.Bias)`
`Rectangle`	`modelToView(JTextComponent tc, int pos, Position.Bias bias)`	Устаревший. заменен на `TextUI.modelToView2D(JTextComponent, int, Position.Bias)`
`final void`	`paint(Graphics g, JComponent c)`	Отрисовывает интерфейс.
`protected void`	`paintBackground(Graphics g)`	Отрисовывает фон для представления.
`protected void`	`paintSafely(Graphics g)`	Безопасно отрисовывает интерфейс с гарантией, что модель не изменится со стороны этого потока.
`protected void`	`propertyChange(PropertyChangeEvent evt)`	Этот метод вызывается, когда связанное свойство изменяется на связанном JTextComponent.
`protected final void`	`setView(View v)`	Устанавливает текущий корень иерархии представлений и вызывает invalidate().
`protected void`	`uninstallDefaults()`	Устанавливает свойства компонента, которые не были явно переопределены, в `null`.
`protected void`	`uninstallKeyboardActions()`	Отменяет регистрацию действий с клавиатуры.
`protected void`	`uninstallListeners()`	Отменяет регистрацию слушателей для интерфейса пользователя.
`void`	`uninstallUI(JComponent c)`	Отменяет установку интерфейса пользователя для компонента.
`void`	`update(Graphics g, JComponent c)`	Предковый класс отрисовывает фон непредсказуемым образом (например, можно захотеть отрисовать изображение, выложенное по фону).
`int`	`viewToModel(JTextComponent tc, Point pt)`	Устаревший. заменен на `TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])`
`int`	`viewToModel(JTextComponent tc, Point pt, Position.Bias[] biasReturn)`	Устаревший. заменен на `TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])`

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

getToolTipText2D, modelToView2D, viewToModel2D

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

contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior

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

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

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

BasicTextUI

public BasicTextUI()

Создаёт новый интерфейс пользователя.

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

createCaret

protected Caret createCaret()

Создаёт объект для использования в качестве курсора. По умолчанию создаётся экземпляр BasicCaret. Этот метод можно переопределить, чтобы использовать что-то другое, что реализует интерфейс InputPosition или подкласс JCaret.

Возвращает:: объект курсора

createHighlighter

protected Highlighter createHighlighter()

Создаёт объект для добавления выделений. По умолчанию создаётся экземпляр BasicHighlighter. Этот метод можно переопределить, чтобы использовать что-то другое, что реализует интерфейс Highlighter или подкласс DefaultHighlighter.

Возвращает:: объект выделения

getKeymapName

protected String getKeymapName()

Возвращает имя макросов, которые будут установлены/использоваться по умолчанию для этого интерфейса пользователя. Эта реализация создаёт имя на основе имени класса. Имя — это имя класса с удалённым префиксом пакета.

Возвращает:: имя

createKeymap

protected Keymap createKeymap()

Создаёт макросы для текстового компонента и устанавливает необходимые привязки в него. По умолчанию макросы используются всеми экземплярами этого типа TextUI. Макросы имеют имя, определённое методом getKeymapName. Если макросы не найдены, используется DEFAULT_KEYMAP из JTextComponent.

Набор привязок, используемых для создания макросов, извлекается из UIManager с помощью ключа, сформированного путём комбинирования метода getPropertyPrefix() и строки .keyBindings. Ожидаемый тип — JTextComponent.KeyBinding[].

Возвращает:

макросы

См. также:

propertyChange

protected void propertyChange(PropertyChangeEvent evt)

Этот метод вызывается, когда связанное свойство изменено в связанном JTextComponent. Это крючок, который реализации интерфейса пользователя могут изменить, чтобы отразить, как интерфейс пользователя отображает связанные свойства подклассов JTextComponent. Этот метод реализован так, чтобы не делать ничего (т. е. реакция на свойства в самом JTextComponent обрабатывается до вызова этого метода). Эта реализация обновляет фон текстового компонента, если меняется состояние editable или enabled.

Параметры:: evt - событие изменения свойства

getPropertyPrefix

protected abstract String getPropertyPrefix()

Получает имя, используемое в качестве ключа для поиска свойств через UIManager. Это используется в качестве префикса ко всем стандартным текстовым свойствам.

Возвращает:: имя

installDefaults

protected void installDefaults()

Инициализирует свойства компонента, такие как шрифт, цвет текста, цвет фона, цвет курсора, цвет выделения, цвет выделенного текста, цвет неактивного текста, граница и отступ. Каждое свойство устанавливается, если его текущее значение равно null или является UIResource.

См. также:

uninstallDefaults

protected void uninstallDefaults()

Устанавливает свойства компонента, которые не были явно переопределены, в значения по умолчанию. Свойство считается переопределённым, если его текущее значение не является UIResource.

См. также:

installListeners

protected void installListeners()

Устанавливает слушатели для интерфейса пользователя.

uninstallListeners

protected void uninstallListeners()

Удаляет слушатели для интерфейса пользователя.

installKeyboardActions

protected void installKeyboardActions()

Регистрирует действия клавиатуры.

uninstallKeyboardActions

protected void uninstallKeyboardActions()

Отменяет регистрацию действий клавиатуры.

paintBackground

protected void paintBackground(Graphics g)

Отображает фон для представления. Этот метод будет вызван только если isOpaque() для связанного компонента равно true. По умолчанию отображается цвет фона компонента.

Параметры:: g - контекст графики

getComponent

protected final JTextComponent getComponent()

Возвращает текстовый компонент, связанный с этой реализацией интерфейса пользователя. Будет null, пока ui не установлен.

Возвращает:: компонент редактора

modelChanged

protected void modelChanged()

Флаги изменений модели. Вызывается всякий раз, когда модель изменяется. Реализуется для перестроения иерархии представления, чтобы отразить корневой элемент по умолчанию связанной модели.

setView

protected final void setView(View v)

Устанавливает текущий корень иерархии представления и вызывает invalidate(). Если были какие-либо дочерние компоненты, они будут удалены (предполагается, что они были получены из компонентов, вложенных в представления).

Параметры:: v - корневое представление

paintSafely

protected void paintSafely(Graphics g)

Безопасно отрисовывает интерфейс с гарантией, что модель не изменится с точки зрения текущего потока. Делает следующее, отрисовывает сверху вниз.

Если компонент отмечен как непрозрачный, рисуется фон текущего цвета фона компонента.
Рисуются выделения (если есть).
Рисуется иерархия представления.
Рисуется курсор.

Параметры:: g - контекст графики

installUI

public void installUI(JComponent c)

Устанавливает интерфейс пользователя для компонента. Делает следующее.

Устанавливает связанный компонент как непрозрачный, если свойство opaque ещё не было установлено программой-клиентом. Это заставит компонент отрисовать цвет фона.
Устанавливает по умолчанию курсор и выделение для связанного компонента. Эти свойства устанавливаются только если их текущее значение равно null или экземпляру UIResource.
Подключается к редактору и модели. Если модели нет, создаётся по умолчанию.
Создаётся фабрика представления и иерархия представления, используемые для представления модели.

Переопределяет:

installUI в классе ComponentUI

Параметры:

c - компонент редактора

См. также:

uninstallUI

public void uninstallUI(JComponent c)

Удаляет интерфейс пользователя из компонента. Удаляет слушатели, отменяет установку выделения, удаляет представления и обнуляет макросы.

Переопределяет:

uninstallUI в классе ComponentUI

Параметры:

c - компонент редактора

См. также:

update

public void update(Graphics g, JComponent c)

Предковый класс отрисовывает фон неконтролируемым способом (например, можно захотеть отрисовать плитку изображения в фоне). Чтобы предотвратить это от двойного отображения, этот метод переопределён для простой отрисовки.

ПРИМЕЧАНИЕ: Предковый класс также не потокобезопасен в отрисовке фона, хотя это не проблема при стандартной отрисовке.

Переопределяет:

update в классе ComponentUI

Параметры:

g - контекст отрисовки

c - компонент, который рисуется; этот аргумент часто игнорируется, но может использоваться, если объект интерфейса пользователя не имеет состояния и используется несколькими компонентами

См. также:

paint

public final void paint(Graphics g, JComponent c)

Отображает интерфейс. Этот метод переадресуется методу paintSafely, гарантируя, что модель не будет изменена с точки зрения текущего потока во время отрисовки (если связанная модель происходит от AbstractDocument). Это позволяет потенциально обновлять модель асинхронно.

Overrides:

paint в классе ComponentUI

Параметры:

g — контекст графики

c — компонент редактора

См. также:

getPreferredSize

public Dimension getPreferredSize(JComponent c)

Получает предпочтительный размер для компонента редактора. Если размер компонента был задан до получения этого запроса, он установит размер иерархии представлений, чтобы отразить размер компонента, прежде чем запросить предпочтительный размер иерархии представлений. Это позволяет отформатированным представлениям отформатироваться до текущего размера компонента перед ответом на запрос. Другие представления не заботятся о текущем отформатированном размере и возвращают одинаковый ответ в любом случае.

Overrides:

getPreferredSize в классе ComponentUI

Параметры:

c — компонент редактора

Возвращает:

размер

См. также:

getMinimumSize

public Dimension getMinimumSize(JComponent c)

Получает минимальный размер для компонента редактора.

Overrides:

getMinimumSize в классе ComponentUI

Параметры:

c — компонент редактора

Возвращает:

размер

См. также:

getMaximumSize

public Dimension getMaximumSize(JComponent c)

Получает максимальный размер для компонента редактора.

Overrides:

getMaximumSize в классе ComponentUI

Параметры:

c — компонент редактора

Возвращает:

размер

См. также:

getVisibleEditorRect

protected Rectangle getVisibleEditorRect()

Получает выделение для корневого представления. Из-за ряда исторических событий это имя метода неуместно. Прямоугольник, возвращаемый этим методом, не имеет ничего общего с видимостью. Для вычисления этого преобразования компонент должен иметь размер больше нуля.

Возвращает:: окружность корневого представления

modelToView

@Deprecated(since="9") public Rectangle modelToView(JTextComponent tc, int pos) throws BadLocationException

Устарело.

заменено на TextUI.modelToView2D(JTextComponent, int, Position.Bias)

Преобразует заданную позицию в модели в позицию в системе координат представления. Для вычисления этого преобразования компонент должен иметь размер больше нуля.

Указано в:

modelToView в классе TextUI

Параметры:

tc — компонент текста, для которого установлен данный интерфейс

pos — локальная позиция в модели для преобразования >= 0

Возвращает:

координаты в виде прямоугольника, null, если модель не отрисовывается

Исключения:

BadLocationException — если заданная позиция не соответствует допустимой позиции в связанном документе

См. также:

modelToView

@Deprecated(since="9") public Rectangle modelToView(JTextComponent tc, int pos, Position.Bias bias) throws BadLocationException

Устарело.

заменено на TextUI.modelToView2D(JTextComponent, int, Position.Bias)

Указано в:

modelToView в классе TextUI

Параметры:

tc — компонент текста, для которого установлен данный интерфейс

pos — локальная позиция в модели для преобразования >= 0

bias — смещение для позиции

Возвращает:

координаты в виде прямоугольника, null, если модель не отрисовывается

Исключения:

BadLocationException — если заданная позиция не соответствует допустимой позиции в связанном документе

См. также:

viewToModel

@Deprecated(since="9") public int viewToModel(JTextComponent tc, Point pt)

Устарело.

заменено на TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])

Преобразует заданную позицию в системе координат представления в ближайшую соответствующую позицию в модели. Для вычисления этого преобразования компонент должен иметь размер больше нуля.

Указано в:

viewToModel в классе TextUI

Параметры:

tc — компонент текста, для которого установлен данный интерфейс

pt — позиция в представлении для преобразования. Должна быть в той же системе координат, что и события мыши.

Возвращает:

смещение от начала документа >= 0, -1, если не отрисовано

См. также:

viewToModel

@Deprecated(since="9") public int viewToModel(JTextComponent tc, Point pt, Position.Bias[] biasReturn)

Устарело.

заменено на TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])

Указано в:

viewToModel в классе TextUI

Параметры:

tc — компонент текста, для которого установлен данный интерфейс

pt — позиция в представлении для преобразования. Должна быть в той же системе координат, что и события мыши.

biasReturn — заполняется этим методом, чтобы указать, ближе ли заданная точка к предыдущему или следующему символу в модели

Возвращает:

смещение от начала документа >= 0, -1, если компонент еще не имеет размера больше нуля.

См. также:

getNextVisualPositionFrom

public int getNextVisualPositionFrom(JTextComponent t, int pos, Position.Bias b, int direction, Position.Bias[] biasRet) throws BadLocationException

Обеспечивает способ определения следующей визуально представленной позиции в модели, куда можно поместить курсор. Некоторые представления могут быть не видны, не следовать тому же порядку, что и в модели, или просто не позволять доступ к некоторым позициям в модели.

Указано в:: getNextVisualPositionFrom в классе TextUI
Параметры:: t — компонент текста, для которого установлен данный интерфейс; pos — позиция для преобразования >= 0; b — смещение для позиции; direction — направление от текущей позиции, которое можно представить как клавиши со стрелками на клавиатуре. Может быть SwingConstants.WEST, SwingConstants.EAST, SwingConstants.NORTH или SwingConstants.SOUTH; biasRet — массив для хранения смещения для возвращаемой позиции
Возвращает:: позиция в модели, которая наилучшим образом представляет следующую визуальную позицию
Исключения:: BadLocationException — для некорректной позиции в модели документа

damageRange

public void damageRange(JTextComponent tc, int p0, int p1)

Вызывает перерисовку части представления, отвечающей за заданную часть модели. Ничего не делает, если представление в данный момент не отрисовывается.

Specified by:

damageRange in class TextUI

Parameters:

tc - текстовый компонент, для которого установлено это пользовательское интерфейсное представление

p0 - начало диапазона >= 0

p1 - конец диапазона >= p0

See Also:

damageRange

public void damageRange(JTextComponent t, int p0, int p1, Position.Bias p0Bias, Position.Bias p1Bias)

Вызывает перерисовку части представления, отвечающей за заданную часть модели.

Specified by:: damageRange in class TextUI
Parameters:: t - текстовый компонент, для которого установлено это пользовательское интерфейсное представление; p0 - начало диапазона >= 0; p1 - конец диапазона >= p0; p0Bias - смещение первой позиции символа, в сторону предыдущего или следующего символа; p1Bias - смещение второй позиции символа, в сторону предыдущего или следующего символа

getEditorKit

public EditorKit getEditorKit(JTextComponent tc)

Возвращает EditorKit для пользовательского интерфейса.

Specified by:

getEditorKit in class TextUI

Parameters:

tc - текстовый компонент, для которого установлено это пользовательское интерфейсное представление

Returns:

возможности редактора

See Also:

getRootView

public View getRootView(JTextComponent tc)

Возвращает представление с размещением связанного текстового компонента (т.е. корень иерархии), которое можно пройти, чтобы определить, как модель представлена пространственно.

Предупреждение: Иерархия представлений может быть пройдена от корневого представления, и могут выполняться и другие действия. Действия, выполняемые таким образом, не могут быть защищены, как простые вызовы методов через TextUI. Поэтому любая логика, вызывающая этот метод, должна обеспечить правильную работу в условиях одновременного доступа!

Specified by:

getRootView in class TextUI

Parameters:

tc - текстовый компонент, для которого установлено это пользовательское интерфейсное представление

Returns:

представление

See Also:

getToolTipText

public String getToolTipText(JTextComponent t, Point pt)

Возвращает строку, используемую в качестве всплывающей подсказки в указанном местоположении. Метод перенаправляется на корневое представление.

Overrides:

getToolTipText in class TextUI

Parameters:

t - текстовый компонент, для которого установлено это пользовательское интерфейсное представление

pt - точка, определяющая местоположение, для которого требуется всплывающая подсказка

Returns:

строка, содержащая всплывающую подсказку

Since:

1.4

See Also:

create

public View create(Element elem)

Создает представление для элемента. Если подкласс хочет напрямую реализовать фабрику, производящую представление(я), он должен переопределить этот метод. По умолчанию он просто возвращает null, указывая, что он не может представить элемент.

Specified by:

create in interface ViewFactory

Parameters:

elem - элемент

Returns:

представление

See Also:

create

public View create(Element elem, int p0, int p1)

Parameters:: elem - элемент; p0 - начальный смещение >= 0; p1 - конечный смещение >= p0
Returns:: представление

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