Интерфейс 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)

Отображает курсор. Этот метод вызывается классами UI.

Параметры:: 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()

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

Возвращает:

визуальную позицию.

См. также:

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