Интерфейс 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 - точка, используемая для сохранения позиции. Может быть null, чтобы указать отсутствие визуального расположения.

getMagicCaretPosition

Point getMagicCaretPosition()

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

Возвращает:

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

См. также:

setMagicCaretPosition(java.awt.Point)

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, 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/text/Caret.html