Интерфейс Caret

public interface Caret

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

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

Методы

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