Класс DefaultCaret

Реализация по умолчанию интерфейса Caret. Курсор отображается как вертикальная линия в цвете, указанном свойством CaretColor связанного JTextComponent. Он может мигать со скоростью, заданной свойством BlinkRate.

Эта реализация ожидает два источника асинхронного уведомления. Поток таймера генерирует асинхронные события, заставляя курсор просто перерисовывать последнюю область. Курсор также отслеживает изменения, когда документ изменяется. Обычно это происходит в потоке обработки событий в результате какого-либо события мыши или клавиатуры. Поведение курсора при синхронных и асинхронных обновлениях документов контролируется свойством UpdatePolicy. Перерисовка нового положения курсора произойдёт в потоке обработки событий в любом случае, так как вызовы modelToView безопасны только в этом потоке.

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

Подсветка, связанная с текстовым компонентом, используется для отображения выделения по умолчанию. Внешний вид выделения можно настроить, указав используемого рисовальщика для подсветки. По умолчанию используется рисовальщик, который отображает сплошной цвет, как указано в связанном текстовом компоненте в свойстве SelectionColor. Это можно легко изменить, переопределив метод getSelectionPainter.

Визуальное оформление курсора можно настроить, переопределив метод paint. Если метод paint изменён, необходимо также переопределить метод damage, чтобы вызвать перерисовку необходимой области для отображения курсора. Курсор расширяет класс Rectangle, который используется для хранения прямоугольной области последнего отображения курсора. Это позволяет курсору перерисовываться потокобезопасным способом при перемещении, без вызова modelToView, который нестабилен между обновлениями модели и ремонтом представления (т.е. порядок доставки DocumentListeners не гарантируется).

Магическое положение курсора устанавливается в null при изменении положения курсора. Используется таймер для определения нового местоположения (после изменения курсора). Когда таймер срабатывает, если магическое положение курсора всё ещё равно null, оно устанавливается в текущую позицию курсора. Любые действия, изменяющие положение курсора и желающие сохранить магическое положение курсора неизменным, должны запомнить магическое положение курсора, изменить курсор, а затем установить магическое положение курсора в его исходное значение. Это выгодно тем, что только действия, которые хотят сохранить магическое положение курсора, должны о нём знать (например, открытие/перемещение вниз).

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. Пожалуйста, обратитесь к XMLEncoder.

Поля

UPDATE_WHEN_ON_EDT

public static final int UPDATE_WHEN_ON_EDT

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

Since:

1.5

См. также:

setUpdatePolicy(int), getUpdatePolicy(), Значения константных полей

NEVER_UPDATE

public static final int NEVER_UPDATE

Указывает, что курсор должен оставаться в той же абсолютной позиции в документе независимо от любых обновлений документа, за исключением случаев, когда длина документа становится меньше текущей позиции курсора из-за удаления. В этом случае позиция курсора корректируется до конца документа.

Since:

1.5

См. также:

setUpdatePolicy(int), getUpdatePolicy(), Значения константных полей

ALWAYS_UPDATE

public static final int ALWAYS_UPDATE

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

Since:

1.5

См. также:

setUpdatePolicy(int), getUpdatePolicy(), Значения константных полей

listenerList

protected EventListenerList listenerList

Список слушателей событий.

changeEvent

protected transient ChangeEvent changeEvent

Событие изменения для модели. Для каждого экземпляра модели требуется только один ChangeEvent, так как единственное состояние события (только для чтения) — свойство источника. Источником событий, сгенерированных здесь, всегда является «this».

Конструкторы

DefaultCaret

public DefaultCaret()

Создаёт стандартный курсор.

Методы

setUpdatePolicy

public void setUpdatePolicy(int policy)

Параметры:

policy - одно из следующих значений: UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE

Исключения:

IllegalArgumentException - если передано недопустимое значение

Since:

1.5

См. также:

getUpdatePolicy(), adjustVisibility(java.awt.Rectangle), UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE

getUpdatePolicy

public int getUpdatePolicy()

Получает политику перемещения курсора при обновлениях документа.

Возвращает:

одно из следующих значений: UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE

Since:

1.5

См. также:

setUpdatePolicy(int), UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE

getComponent

protected final JTextComponent getComponent()

Получает текстовый компонент редактора, к которому привязан этот курсор.

Возвращает:

компонент

repaint

protected final void repaint()

damage

protected void damage(Rectangle r)

Повреждает область вокруг курсора, чтобы вызвать его перерисовку в новом месте. Если paint() переопределён, этот метод также должен быть переопределён. Этот метод должен обновить границы курсора (x, y, ширина и высота).

Параметры:

r - текущее положение курсора

См. также:

paint(java.awt.Graphics)

adjustVisibility

protected void adjustVisibility(Rectangle nloc)

Прокручивает связанное представление (при необходимости), чтобы сделать курсор видимым. Поскольку способ выполнения этого действия является определённой политикой, этот метод можно переопределить, чтобы изменить поведение. По умолчанию вызывается метод scrollRectToVisible на связанном компоненте.

Параметры:

nloc - новое положение для прокрутки

getSelectionPainter

protected Highlighter.HighlightPainter getSelectionPainter()

Получает рисовальщик для выделения.

Возвращает:

рисовальщик

positionCaret

protected void positionCaret(MouseEvent e)

Пытается установить позицию курсора по координатам события мыши, используя viewToModel().

Параметры:

e - событие мыши

moveCaret

protected void moveCaret(MouseEvent e)

Пытается переместить позицию курсора по координатам события мыши, используя viewToModel(). Это вызовет выделение, если точка и метка отличаются.

Параметры:

e - событие мыши

focusGained

public void focusGained(FocusEvent e)

Вызывается, когда компонент, содержащий курсор, получает фокус. Реализуется для отображения курсора, если компонент редактируемый.

Определено в:

focusGained в интерфейсе FocusListener

Параметры:

e - событие фокуса

См. также:

FocusListener.focusGained(java.awt.event.FocusEvent)

focusLost

public void focusLost(FocusEvent e)

Вызывается, когда компонент, содержащий курсор, теряет фокус. Реализуется для скрытия курсора.

Определено в:

focusLost в интерфейсе FocusListener

Параметры:

e - событие фокуса

См. также:

FocusListener.focusLost(java.awt.event.FocusEvent)

mouseClicked

public void mouseClicked(MouseEvent e)

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

Определено в:

mouseClicked в интерфейсе MouseListener

Параметры:

e - событие мыши

См. также:

MouseListener.mouseClicked(java.awt.event.MouseEvent)

mousePressed

public void mousePressed(MouseEvent e)

Если нажата левая кнопка мыши, это реализуется для запроса фокуса на связанный текстовый компонент и установки позиции курсора. Если клавиша Shift удерживается, курсор будет перемещён, что может привести к выделению, в противном случае позиция курсора будет установлена в новом местоположении. Если компонент не активен, запрос фокуса не будет выполнен.

Определено в:

mousePressed в интерфейсе MouseListener

Параметры:

e - событие мыши

См. также:

MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(MouseEvent e)

Вызывается при отпускании кнопки мыши.

Определено в:

mouseReleased в интерфейсе MouseListener

Параметры:

e - событие мыши

См. также:

MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(MouseEvent e)

Вызывается при входе мыши в область.

Определено в:

mouseEntered в интерфейсе MouseListener

Параметры:

e - событие мыши

См. также:

MouseListener.mouseEntered(java.awt.event.MouseEvent)

mouseExited

public void mouseExited(MouseEvent e)

Вызывается при выходе мыши из области.

Определено в:

mouseExited в интерфейсе MouseListener

Параметры:

e - событие мыши

См. также:

MouseListener.mouseExited(java.awt.event.MouseEvent)

mouseDragged

public void mouseDragged(MouseEvent e)

Перемещает позицию курсора в соответствии с текущим положением указателя мыши. Это эффективно расширяет выделение. По умолчанию это выполняется только для кнопки мыши 1.

Определено в:

mouseDragged в интерфейсе MouseMotionListener

Параметры:

e - событие мыши

См. также:

MouseMotionListener.mouseDragged(java.awt.event.MouseEvent)

mouseMoved

public void mouseMoved(MouseEvent e)

Вызывается при перемещении мыши.

Определено в:

mouseMoved в интерфейсе MouseMotionListener

Параметры:

e - событие мыши

См. также:

MouseMotionListener.mouseMoved(java.awt.event.MouseEvent)

paint

public void paint(Graphics g)

Определено в:

paint в интерфейсе Caret

Параметры:

g - контекст графики

См. также:

damage(java.awt.Rectangle)

install

public void install(JTextComponent c)

Вызывается при установке пользовательского интерфейса в интерфейс JTextComponent. Это можно использовать для доступа к модели, по которой происходит навигация в реализации этого интерфейса. Устанавливает dot и mark в 0 и устанавливает слушателей документов, изменений свойств, фокуса, мыши и движений мыши.

Определено в:

install в интерфейсе Caret

Параметры:

c - компонент

См. также:

Caret.install(javax.swing.text.JTextComponent)

deinstall

public void deinstall(JTextComponent c)

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

Определено в:

deinstall в интерфейсе Caret

Параметры:

c - компонент

См. также:

Caret.deinstall(javax.swing.text.JTextComponent)

addChangeListener

public void addChangeListener(ChangeListener l)

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

Определено в:

addChangeListener в интерфейсе Caret

Параметры:

l - слушатель

См. также:

Caret.addChangeListener(javax.swing.event.ChangeListener)

removeChangeListener

public void removeChangeListener(ChangeListener l)

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

Определено в:

removeChangeListener в интерфейсе Caret

Параметры:

l - слушатель

См. также:

Caret.removeChangeListener(javax.swing.event.ChangeListener)

getChangeListeners

public ChangeListener[] getChangeListeners()

Возвращает массив всех слушателей изменений, зарегистрированных на этом курсоре.

Возвращает:

все слушатели изменений этого курсора или пустой массив, если слушатели изменений не зарегистрированы

С момента:

1.4

См. также:

addChangeListener(javax.swing.event.ChangeListener), removeChangeListener(javax.swing.event.ChangeListener)

fireStateChanged

protected void fireStateChanged()

Уведомляет всех слушателей, которые проявили интерес к уведомлениям об этом типе события. Экземпляр события создаётся лениво с использованием параметров, переданных в метод fire. Список слушателей обрабатывается последним к первому.

См. также:

EventListenerList

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

ChangeListener[] cls = (ChangeListener[])(c.getListeners(ChangeListener.class));

Параметры:

listenerType - тип запрашиваемых слушателей; этот параметр должен указать интерфейс, который унаследован от java.util.EventListener

Возвращает:

массив всех объектов, зарегистрированных в качестве слушателей на этом компоненте, или пустой массив, если такие слушатели не были добавлены

Исключения:

ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener

С момента:

1.3

См. также:

getChangeListeners()

setSelectionVisible

public void setSelectionVisible(boolean vis)

Изменяет видимость выделения.

Определено в:

setSelectionVisible в интерфейсе Caret

Параметры:

vis - новая видимость

isSelectionVisible

public boolean isSelectionVisible()

Проверяет, видимое ли текущее выделение.

Определено в:

isSelectionVisible в интерфейсе Caret

Возвращает:

true, если выделение видно

isActive

public boolean isActive()

Возвращает:

true если активен, иначе false

С момента:

1.5

См. также:

isVisible()

isVisible

public boolean isVisible()

Определено в:

isVisible в интерфейсе Caret

Возвращает:

true, если виден, иначе false

См. также:

Caret.isVisible(), isActive()

setVisible

public void setVisible(boolean e)

Определено в:

setVisible в интерфейсе Caret

Параметры:

e - значение видимости

См. также:

isActive(), Caret.setVisible(boolean)

setBlinkRate

public void setBlinkRate(int rate)

Устанавливает скорость мигания курсора.

Определено в:

setBlinkRate в интерфейсе Caret

Параметры:

rate - скорость в миллисекундах, 0 для остановки мигания

См. также:

Caret.setBlinkRate(int)

getBlinkRate

public int getBlinkRate()

Получает скорость мигания курсора.

Определено в:

getBlinkRate в интерфейсе Caret

Возвращает:

задержка в миллисекундах. Если она равна нулю, курсор не будет мигать.

См. также:

Caret.getBlinkRate()

getDot

public int getDot()

Получает текущую позицию курсора.

Определено в:

getDot в интерфейсе Caret

Возвращает:

позиция >= 0

См. также:

Caret.getDot()

getMark

public int getMark()

Получает текущее положение метки. Если есть выделение, точка и метка не будут совпадать.

Определено в:

getMark в интерфейсе Caret

Возвращает:

положение >= 0

См. также:

Caret.getMark()

setDot

public void setDot(int dot)

Устанавливает позицию курсора и метку в указанное положение со смещением вперед. Это неявно устанавливает диапазон выделения в ноль.

Определено в:

setDot в интерфейсе Caret

Параметры:

dot - положение >= 0

См. также:

setDot(int, Position.Bias), Caret.setDot(int)

moveDot

public void moveDot(int dot)

Перемещает позицию курсора в указанное положение со смещением вперед.

Определено в:

moveDot в интерфейсе Caret

Параметры:

dot - положение >= 0

См. также:

moveDot(int, javax.swing.text.Position.Bias), Caret.moveDot(int)

moveDot

public void moveDot(int dot,
                    Position.Bias dotBias)

Перемещает позицию курсора в указанное положение с указанным смещением.

Параметры:

dot - положение >= 0

dotBias - смещение для этого положения, не null

Исключения:

IllegalArgumentException - если смещение null

С:

1.6

См. также:

Caret.moveDot(int)

setDot

public void setDot(int dot,
                   Position.Bias dotBias)

Устанавливает позицию курсора и метку в указанное положение с указанным смещением. Это неявно устанавливает диапазон выделения в ноль.

Параметры:

dot - положение >= 0

dotBias - смещение для этого положения, не null

Исключения:

IllegalArgumentException - если смещение null

С:

1.6

См. также:

Caret.setDot(int)

getDotBias

public Position.Bias getDotBias()

Возвращает смещение позиции курсора.

Возвращает:

смещение позиции курсора

С:

1.6

getMarkBias

public Position.Bias getMarkBias()

Возвращает смещение метки.

Возвращает:

смещение метки

С:

1.6

setMagicCaretPosition

public void setMagicCaretPosition(Point p)

Сохраняет текущую позицию курсора. Это используется при действиях перемещения курсора вверх/вниз, перемещаясь между строками, которые имеют неравные конечные позиции.

Определено в:

setMagicCaretPosition в интерфейсе Caret

Параметры:

p - позиция

См. также:

getMagicCaretPosition()

getMagicCaretPosition

public Point getMagicCaretPosition()

Получает сохраненную позицию курсора.

Определено в:

getMagicCaretPosition в интерфейсе Caret

Возвращает:

позицию, см. #setMagicCaretPosition

См. также:

Caret.setMagicCaretPosition(java.awt.Point)

equals

public boolean equals(Object obj)

Сравнивает этот объект с указанным объектом. Поведение суперкласса по сравнению прямоугольников нежелательно, поэтому это изменено на поведение объекта.

Переопределяет:

equals в классе Rectangle

Параметры:

obj - объект для сравнения с этим шрифтом

Возвращает:

true если объекты равны; false в противном случае

См. также:

Object.hashCode(), HashMap

toString

public String toString()

Описание скопировано из класса: Rectangle

Возвращает строковое представление этого объекта и его значений.

Переопределяет:

toString в классе Rectangle

Возвращает:

строковое представление координат и значений размера этого объекта.