Интерфейс Caret

Все известные реализующие классы:: BasicTextUI.BasicCaret, DefaultCaret

public interface Caret

Место в представлении документа, указывающее, куда можно вставлять содержимое в модель документа. У каретки есть позиция в документе, называемая точкой. Точка — это место, где каретка в данный момент находится в модели. Каретка также хранит вторую позицию, представляющую другой конец выделения и называемую меткой. Если выделения нет, точка и метка совпадают. Если выделение есть, эти значения различаются.

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

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

Модификатор и тип	Метод	Описание
`void`	`addChangeListener(ChangeListener l)`	Добавляет слушателя для отслеживания изменений позиции каретки.
`void`	`deinstall(JTextComponent c)`	Вызывается при удалении пользовательского интерфейса из интерфейса JTextComponent.
`int`	`getBlinkRate()`	Возвращает частоту мигания каретки.
`int`	`getDot()`	Возвращает текущую позицию каретки.
`Point`	`getMagicCaretPosition()`	Возвращает текущее визуальное положение каретки.
`int`	`getMark()`	Возвращает текущую позицию метки.
`void`	`install(JTextComponent c)`	Вызывается при установке пользовательского интерфейса в интерфейс JTextComponent.
`boolean`	`isSelectionVisible()`	Определяет, отображается ли в данный момент выделение.
`boolean`	`isVisible()`	Определяет, отображается ли в данный момент каретка.
`void`	`moveDot(int dot)`	Перемещает позицию каретки (точку) в другое место, оставляя метку на прежнем месте.
`void`	`paint(Graphics g)`	Отображает каретку.
`void`	`removeChangeListener(ChangeListener l)`	Удаляет слушателя, отслеживавшего изменения позиции каретки.
`void`	`setBlinkRate(int rate)`	Задает частоту мигания каретки.
`void`	`setDot(int dot)`	Задает позицию каретки.
`void`	`setMagicCaretPosition(Point p)`	Задает текущее визуальное положение каретки.
`void`	`setSelectionVisible(boolean v)`	Задает видимость выделения
`void`	`setVisible(boolean v)`	Задает видимость каретки.

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

install

void install(JTextComponent c)

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

Параметры:: c — JTextComponent

deinstall

void deinstall(JTextComponent c)

Вызывается при удалении пользовательского интерфейса из интерфейса JTextComponent. Используется для снятия регистрации всех добавленных слушателей.

Параметры:: c — JTextComponent

paint

void paint(Graphics g)

Отображает каретку. Этот метод вызывается классами пользовательского интерфейса.

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

addChangeListener

void addChangeListener(ChangeListener l)

Добавляет слушателя для отслеживания изменений позиции каретки.

Параметры:: l — слушатель изменений

removeChangeListener

void removeChangeListener(ChangeListener l)

Удаляет слушателя, отслеживавшего изменения позиции каретки.

Параметры:: l — слушатель изменений

isVisible

boolean isVisible()

Определяет, отображается ли в данный момент каретка.

Возвращает:: true, если каретка отображается, иначе false

setVisible

void setVisible(boolean v)

Задает видимость каретки.

Параметры:: v — true, если каретку следует отображать, и false, если каретку следует скрыть

isSelectionVisible

boolean isSelectionVisible()

Определяет, отображается ли в данный момент выделение.

Возвращает:: true, если каретка отображается, иначе false

setSelectionVisible

void setSelectionVisible(boolean v)

Задает видимость выделения

Параметры:: v — true, если каретку следует отображать, и false, если каретку следует скрыть

setMagicCaretPosition

void setMagicCaretPosition(Point p)

Задает текущее визуальное положение каретки. Это можно использовать при переходе между строками с разной конечной позицией (например, при перемещении каретки вверх или вниз). При направлении текста слева направо или справа налево координата x указывает желаемую позицию навигации при вертикальном перемещении. При направлении текста сверху вниз координата y указывает желаемую позицию навигации при горизонтальном перемещении.

Параметры:: p — объект Point, задающий сохраняемую позицию. Может быть равен null, что означает отсутствие визуального положения.

getMagicCaretPosition

Point getMagicCaretPosition()

Возвращает текущее визуальное положение каретки.

Возвращает:

визуальное положение.

См. также:

setBlinkRate

void setBlinkRate(int rate)

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

Параметры:: rate — задержка в миллисекундах >=0. Если значение равно нулю, каретка не будет мигать.

getBlinkRate

int getBlinkRate()

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

Возвращает:: задержку в миллисекундах >=0. Если значение равно нулю, каретка не будет мигать.

getDot

int getDot()

Возвращает текущую позицию каретки.

Возвращает:: позицию >=0

getMark

int getMark()

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

Возвращает:: позицию >=0

setDot

void setDot(int dot)

Задает позицию каретки. В результате метка устанавливается в ту же позицию, что и точка, фактически обнуляя диапазон выделения.

Если параметр отрицательный или превышает длину документа, каретка устанавливается соответственно в начало или конец документа.

Параметры:: dot — новая позиция каретки

moveDot

void moveDot(int dot)

Перемещает позицию каретки (точку) в другое место, оставляя метку на прежнем месте. Это полезно для создания выделений.

Параметры:: dot — новая позиция каретки >=0

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/text/Caret.html