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