Класс JTextComponent.AccessibleJTextComponent

public class JTextComponent.AccessibleJTextComponent
extends JComponent.AccessibleJComponent
implements AccessibleText, CaretListener, DocumentListener, AccessibleAction, AccessibleEditableText, AccessibleExtendedText

Этот класс реализует поддержку доступности для класса JTextComponent. Он предоставляет реализацию API доступности Java, подходящую для элементов пользовательского интерфейса меню.

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

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

AccessibleJTextComponent

public AccessibleJTextComponent()

Создаёт AccessibleJTextComponent. Добавляет слушатель для отслеживания изменения курсора.

Методы

caretUpdate

public void caretUpdate(CaretEvent e)

Обрабатывает обновления курсора (вызывает соответствующие события изменения свойств, которые являются AccessibleContext.ACCESSIBLE_CARET_PROPERTY и AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY). Это отслеживает положение точки внутри.

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

Указано:

caretUpdate в интерфейсе CaretListener

Параметры:

e - событие CaretEvent

insertUpdate

public void insertUpdate(DocumentEvent e)

Обрабатывает вставку в документ (вызывает соответствующее событие изменения свойства, которое является AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). Отслеживает изменённый смещение через событие.

Указано:

insertUpdate в интерфейсе DocumentListener

Параметры:

e - событие DocumentEvent

removeUpdate

public void removeUpdate(DocumentEvent e)

Обрабатывает удаление из документа (вызывает соответствующее событие изменения свойства, которое является AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). Отслеживает изменённый смещение через событие.

Указано:

removeUpdate в интерфейсе DocumentListener

Параметры:

e - событие DocumentEvent

changedUpdate

public void changedUpdate(DocumentEvent e)

Обрабатывает изменения в документе (вызывает соответствующее событие изменения свойства, которое является AccessibleContext.ACCESSIBLE_TEXT_PROPERTY). Отслеживает изменённый смещение через событие.

Указано:

changedUpdate в интерфейсе DocumentListener

Параметры:

e - событие DocumentEvent

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Получает набор состояний JTextComponent. Набор состояний AccessibleState объекта состоит из набора уникальных AccessibleState. Изменение набора AccessibleState объекта вызовет событие PropertyChangeEvent для свойства AccessibleContext.ACCESSIBLE_STATE_PROPERTY.

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

getAccessibleStateSet в классе JComponent.AccessibleJComponent

Возвращает:

экземпляр AccessibleStateSet, содержащий текущий набор состояний объекта

См. также:

AccessibleStateSet, AccessibleState, JComponent.AccessibleJComponent.addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleRole

public AccessibleRole getAccessibleRole()

Получает роль этого объекта.

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

getAccessibleRole в классе JComponent.AccessibleJComponent

Возвращает:

экземпляр AccessibleRole, описывающий роль объекта (AccessibleRole.TEXT)

См. также:

AccessibleRole

getAccessibleText

public AccessibleText getAccessibleText()

Получает AccessibleText, связанный с этим объектом. В реализации Java Accessibility API для этого класса возвращает этот объект, который отвечает за реализацию интерфейса AccessibleText от своего имени.

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

getAccessibleText в классе AccessibleContext

Возвращает:

этот объект

См. также:

AccessibleText

getIndexAtPoint

public int getIndexAtPoint(Point p)

Принимая точку в локальных координатах, возвращает индекс символа с нулевой базой под этой точкой. Если точка неверна, этот метод возвращает -1.

Указано:

getIndexAtPoint в интерфейсе AccessibleText

Параметры:

p - точка в локальных координатах

Возвращает:

индекс символа с нулевой базой под точкой p.

getCharacterBounds

public Rectangle getCharacterBounds(int i)

Определяет ограничивающую рамку символа по заданному индексу в строке. Границы возвращаются в локальных координатах. Если индекс некорректен, возвращается пустой прямоугольник. Координаты экрана, возвращаемые, являются "непрокрученными координатами", если JTextComponent содержится в JScrollPane, в этом случае полученный прямоугольник должен быть составлен с координатами родителя. Хороший алгоритм для использования:

Accessible a:
 AccessibleText at = a.getAccessibleText();
 AccessibleComponent ac = a.getAccessibleComponent();
 Rectangle r = at.getCharacterBounds();
 Point p = ac.getLocation();
 r.x += p.x;
 r.y += p.y;

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

Указано:

getCharacterBounds в интерфейсе AccessibleText

Параметры:

i - индекс в строке ≥ 0

Возвращает:

координаты экрана ограничивающей рамки символа

getCharCount

public int getCharCount()

Возвращает количество символов (действительные индексы)

Указано:

getCharCount в интерфейсе AccessibleText

Возвращает:

количество символов ≥ 0

getCaretPosition

public int getCaretPosition()

Возвращает смещение курсора с нулевой базой. Примечание: символу справа от курсора будет соответствовать такое же значение индекса, как и смещение (курсор находится между двумя символами).

Указано:

getCaretPosition в интерфейсе AccessibleText

Возвращает:

смещение курсора с нулевой базой.

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)

Возвращает AttributeSet для заданного символа (по заданному индексу).

Указано:

getCharacterAttribute в интерфейсе AccessibleText

Параметры:

i - индекс в тексте с нулевой базой

Возвращает:

AttributeSet символа

getSelectionStart

public int getSelectionStart()

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

Указано:

getSelectionStart в интерфейсе AccessibleText

Возвращает:

индекс в тексте начала выделения ≥ 0

getSelectionEnd

public int getSelectionEnd()

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

Указано:

getSelectionEnd в интерфейсе AccessibleText

Возвращает:

индекс в тексте конца выделения ≥ 0

getSelectedText

public String getSelectedText()

Возвращает часть текста, которая выделена.

Указано:

getSelectedText в интерфейсе AccessibleText

Возвращает:

текст, null если нет выделения

getAtIndex

public String getAtIndex(int part,
                         int index)

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

Указано:

getAtIndex в интерфейсе AccessibleText

Параметры:

part - СИМВОЛ, СЛОВО или ПРЕДЛОЖЕНИЕ для извлечения

index - индекс в тексте

Возвращает:

буква, слово или предложение.

getAfterIndex

public String getAfterIndex(int part,
                            int index)

Возвращает строку после заданного индекса. Пробелы между словами обрабатываются как слово.

Указано:

getAfterIndex в интерфейсе AccessibleText

Параметры:

part - СИМВОЛ, СЛОВО или ПРЕДЛОЖЕНИЕ для извлечения

index - индекс в тексте

Возвращает:

буква, слово или предложение.

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)

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

Указано:

getBeforeIndex в интерфейсе AccessibleText

Параметры:

part - СИМВОЛ, СЛОВО или ПРЕДЛОЖЕНИЕ для извлечения

index - индекс в тексте

Возвращает:

буква, слово или предложение.

getAccessibleEditableText

public AccessibleEditableText getAccessibleEditableText()

Возвращает интерфейс AccessibleEditableText для этого компонента текста.

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

getAccessibleEditableText в классе AccessibleContext

Возвращает:

интерфейс AccessibleEditableText

С:

1.4

См. также:

AccessibleEditableText

setTextContents

public void setTextContents(String s)

Устанавливает содержимое текста в указанную строку.

Указано:

setTextContents в интерфейсе AccessibleEditableText

Параметры:

s - строка для установки содержимого текста

С:

1.4

insertTextAtIndex

public void insertTextAtIndex(int index,
                              String s)

Вставляет указанную строку по заданному индексу.

Указано:

insertTextAtIndex в интерфейсе AccessibleEditableText

Параметры:

index - индекс в тексте, где будет вставлена строка

s - строка для вставки в текст

С:

1.4

getTextRange

public String getTextRange(int startIndex,
                           int endIndex)

Возвращает строку текста между двумя индексами.

Указано:

getTextRange в интерфейсе AccessibleEditableText

Указано:

getTextRange в интерфейсе AccessibleExtendedText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

Возвращает:

строка текста между индексами

С:

1.4

delete

public void delete(int startIndex,
                   int endIndex)

Удаляет текст между двумя индексами

Определено:

delete в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

С:

1.4

cut

public void cut(int startIndex,
                int endIndex)

Вырезает текст между двумя индексами в буфер обмена системы.

Определено:

cut в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

С:

1.4

paste

public void paste(int startIndex)

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

Определено:

paste в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

С:

1.4

replaceText

public void replaceText(int startIndex,
                        int endIndex,
                        String s)

Заменяет текст между двумя индексами указанной строкой.

Определено:

replaceText в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

s - строка для замены текста между двумя индексами

С:

1.4

selectText

public void selectText(int startIndex,
                       int endIndex)

Выделяет текст между двумя индексами.

Определено:

selectText в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

С:

1.4

setAttributes

public void setAttributes(int startIndex,
                          int endIndex,
                          AttributeSet as)

Устанавливает атрибуты для текста между двумя индексами.

Определено:

setAttributes в интерфейсе AccessibleEditableText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

as - набор атрибутов

С:

1.4

См. также:

AttributeSet

getTextSequenceAt

public AccessibleTextSequence getTextSequenceAt(int part,
                                                int index)

Возвращает AccessibleTextSequence по заданному index.

Определено:

getTextSequenceAt в интерфейсе AccessibleExtendedText

Параметры:

part - CHARACTER, WORD, SENTENCE, LINE или ATTRIBUTE_RUN для извлечения

index - индекс внутри текста

Возвращает:

объект AccessibleTextSequence , определяющий текст, если part и index допустимы. В противном случае возвращается null

С:

1.6

См. также:

AccessibleText.CHARACTER, AccessibleText.WORD, AccessibleText.SENTENCE, AccessibleExtendedText.LINE, AccessibleExtendedText.ATTRIBUTE_RUN

getTextSequenceAfter

public AccessibleTextSequence getTextSequenceAfter(int part,
                                                   int index)

Возвращает AccessibleTextSequence после заданного index.

Определено:

getTextSequenceAfter в интерфейсе AccessibleExtendedText

Параметры:

part - CHARACTER, WORD, SENTENCE, LINE или ATTRIBUTE_RUN для извлечения

index - индекс внутри текста

Возвращает:

объект AccessibleTextSequence , определяющий текст, если part и index допустимы. В противном случае возвращается null

С:

1.6

См. также:

AccessibleText.CHARACTER, AccessibleText.WORD, AccessibleText.SENTENCE, AccessibleExtendedText.LINE, AccessibleExtendedText.ATTRIBUTE_RUN

getTextSequenceBefore

public AccessibleTextSequence getTextSequenceBefore(int part,
                                                    int index)

Возвращает AccessibleTextSequence перед заданным index.

Определено:

getTextSequenceBefore в интерфейсе AccessibleExtendedText

Параметры:

part - CHARACTER, WORD, SENTENCE, LINE или ATTRIBUTE_RUN для извлечения

index - индекс внутри текста

Возвращает:

объект AccessibleTextSequence , определяющий текст, если part и index допустимы. В противном случае возвращается null

С:

1.6

См. также:

AccessibleText.CHARACTER, AccessibleText.WORD, AccessibleText.SENTENCE, AccessibleExtendedText.LINE, AccessibleExtendedText.ATTRIBUTE_RUN

getTextBounds

public Rectangle getTextBounds(int startIndex,
                               int endIndex)

Возвращает Rectangle , охватывающую текст между двумя индексами.

Определено:

getTextBounds в интерфейсе AccessibleExtendedText

Параметры:

startIndex - начальный индекс в тексте

endIndex - конечный индекс в тексте

Возвращает:

прямоугольник, ограничивающий текст, если индексы допустимы. В противном случае возвращается null

С:

1.6

getAccessibleAction

public AccessibleAction getAccessibleAction()

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

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

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

getAccessibleAction в классе AccessibleContext

Возвращает:

AccessibleAction, если поддерживается объектом; иначе возвращает null

См. также:

AccessibleAction

getAccessibleActionCount

public int getAccessibleActionCount()

Возвращает количество доступных действий в этом объекте. Если их несколько, первое считается «стандартным» действием объекта.

Определено:

getAccessibleActionCount в интерфейсе AccessibleAction

Возвращает:

число действий в этом объекте (нумерация с нуля)

С:

1.4

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)

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

Определено:

getAccessibleActionDescription в интерфейсе AccessibleAction

Параметры:

i - индекс действия (нумерация с нуля)

Возвращает:

строковое описание действия

С:

1.4

См. также:

getAccessibleActionCount()

doAccessibleAction

public boolean doAccessibleAction(int i)

Выполняет указанное действие над объектом.

Определено:

doAccessibleAction в интерфейсе AccessibleAction

Параметры:

i - индекс действия (нумерация с нуля)

Возвращает:

true, если действие было выполнено; иначе false.

С:

1.4

См. также:

getAccessibleActionCount()