Класс 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.

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

Modifier and Type	Class	Description
`static class`	`BasicTextUI.BasicCaret`	Базовая реализация интерфейса `Caret`.
`static class`	`BasicTextUI.BasicHighlighter`	Базовая реализация интерфейса `Highlighter`.

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

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

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

Modifier and Type	Метод	Описание
`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 для UI.
`protected String`	`getKeymapName()`	Получает имя схемы навигации, которая будет установлена/использоваться по умолчанию для этого UI.
`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()`	Устанавливает слушателей для UI.
`void`	`installUI(JComponent c)`	Устанавливает UI для компонента.
`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()`	Отменяет установку слушателей для UI.
`void`	`uninstallUI(JComponent c)`	Отменяет установку UI для компонента.
`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. Это крючок, который реализации UI могут изменить, чтобы отразить, как UI отображает связанные свойства подклассов JTextComponent. Эта реализация ничего не делает (т.е. ответ на свойства в JTextComponent обрабатывается до вызова этого метода). Эта реализация обновляет фон текстового компонента, если меняются состояния editable и/или enabled.

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

getPropertyPrefix

protected abstract String getPropertyPrefix()

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

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

installDefaults

protected void installDefaults()

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

См. также:

uninstallDefaults

protected void uninstallDefaults()

Устанавливает свойства компонента, которые не были явно переопределены, в null. Свойство считается переопределённым, если его текущее значение не является 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 до установки пользовательского интерфейса.

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

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 - контекст Graphics для рисования

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

См. также:

paint

public final void paint(Graphics g, JComponent c)

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

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

paint в классе ComponentUI

Параметры:

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

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

См. также:

END_OF_DOCUMENT_MARKER

getPreferredSize

public Dimension getPreferredSize(JComponent c)

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

Overrides:

getPreferredSize в классе ComponentUI

Parameters:

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

Returns:

размер

See Also:

getMinimumSize

public Dimension getMinimumSize(JComponent c)

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

Overrides:

getMinimumSize в классе ComponentUI

Parameters:

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

Returns:

размер

See Also:

getMaximumSize

public Dimension getMaximumSize(JComponent c)

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

Overrides:

getMaximumSize в классе ComponentUI

Parameters:

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

Returns:

размер

See Also:

getVisibleEditorRect

protected Rectangle getVisibleEditorRect()

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

Returns:: прямоугольник, определяющий область корневого представления

modelToView

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

Устарело.

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

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

Specified by:

modelToView в классе TextUI

Parameters:

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

pos - локальное положение в модели, подлежащее преобразованию >= 0

Returns:

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

Throws:

BadLocationException - если заданное положение не соответствует допустимому положению в связанном документе

See Also:

modelToView

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

Устарело.

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

Specified by:

modelToView в классе TextUI

Parameters:

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

pos - локальное положение в модели, подлежащее преобразованию >= 0

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

Returns:

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

Throws:

BadLocationException - если заданное положение не соответствует допустимому положению в связанном документе

See Also:

viewToModel

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

Устарело.

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

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

Specified by:

viewToModel в классе TextUI

Parameters:

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

pt - положение в представлении, подлежащее преобразованию. Оно должно находиться в той же системе координат, что и события мыши.

Returns:

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

See Also:

viewToModel

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

Устарело.

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

Specified by:

viewToModel в классе TextUI

Parameters:

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

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

Returns:

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

See Also:

getNextVisualPositionFrom

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

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

Specified by:: getNextVisualPositionFrom в классе TextUI
Parameters:: t - текстовый компонент, для которого установлен этот пользовательский интерфейс; pos - положение, подлежащее преобразованию >= 0; b - смещение для позиции; direction - направление от текущего положения, которое можно представить как клавиши со стрелками, обычно присутствующие на клавиатуре. Это может быть SwingConstants.WEST, SwingConstants.EAST, SwingConstants.NORTH или SwingConstants.SOUTH; biasRet - массив, содержащий смещение для возвращаемого положения
Returns:: положение в модели, которое лучше всего представляет следующее визуальное положение
Throws:: BadLocationException - для неверного положения в модели документа

damageRange

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

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

Specified by:

damageRange в классе 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)

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

Определено в:: damageRange в классе TextUI
Параметры:: t - текстовый компонент, для которого установлен данный интерфейс UI; p0 - начало диапазона >= 0; p1 - конец диапазона >= p0; p0Bias - смещение первой позиции символа, в сторону предыдущего или следующего символа; p1Bias - смещение второй позиции символа, в сторону предыдущего или следующего символа

getEditorKit

public EditorKit getEditorKit(JTextComponent tc)

Возвращает EditorKit для UI.

Определено в:

getEditorKit в классе TextUI

Параметры:

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

Возвращает:

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

См. также:

getRootView

public View getRootView(JTextComponent tc)

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

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

Определено в:

getRootView в классе TextUI

Параметры:

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

Возвращает:

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

См. также:

getToolTipText

public String getToolTipText(JTextComponent t, Point pt)

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

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

getToolTipText в классе TextUI

Параметры:

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

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

Возвращает:

строку, содержащую подсказку

С момента:

1.4

См. также:

create

public View create(Element elem)

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

Определено в:

create в интерфейсе ViewFactory

Параметры:

elem - элемент

Возвращает:

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

См. также:

create

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

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

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