Класс AttributedString

public class AttributedString
extends Object

Класс AttributedString хранит текст и связанную с ним информацию об атрибутах. Он может использоваться в качестве фактического хранилища данных в некоторых случаях, когда текстовый обработчик хочет получить доступ к атрибутированному тексту через интерфейс AttributedCharacterIterator.

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

Значения атрибутов неизменяемы, или не должны изменяться клиентами или хранилищем. Они всегда передаются по ссылке, а не клонируются.

Подробное описание конструкторов

AttributedString

public AttributedString(String text)

Создаёт экземпляр AttributedString с заданным текстом.

Параметры:

text - Текст для этой атрибутированной строки.

Исключения:

NullPointerException - если text равно null.

AttributedString

public AttributedString(String text,
                        Map<? extends AttributedCharacterIterator.Attribute,?> attributes)

Создаёт экземпляр AttributedString с заданным текстом и атрибутами.

Параметры:

text - Текст для этой атрибутированной строки.

attributes - Атрибуты, применяемые ко всей строке.

Исключения:

NullPointerException - если text или attributes равно null.

IllegalArgumentException - если длина текста равна 0, а параметр attributes не является пустым Map (атрибуты не могут быть применены к диапазону длиной 0).

AttributedString

public AttributedString(AttributedCharacterIterator text)

Создаёт экземпляр AttributedString с заданным атрибутированным текстом, представленным AttributedCharacterIterator.

Параметры:

text - Текст для этой атрибутированной строки.

Исключения:

NullPointerException - если text равно null.

AttributedString

public AttributedString(AttributedCharacterIterator text,
                        int beginIndex,
                        int endIndex)

Создаёт экземпляр AttributedString с подстрокой заданного атрибутированного текста, представленного AttributedCharacterIterator. Если заданный диапазон создаёт пустой текст, все атрибуты будут отброшены. Обратите внимание, что любые атрибуты, заключённые в объект Annotation, отбрасываются для поддиапазона исходного диапазона атрибутов.

Параметры:

text - Текст для этой атрибутированной строки.

beginIndex - Индекс первого символа диапазона.

endIndex - Индекс символа, следующего за последним символом диапазона.

Исключения:

NullPointerException - если text равно null.

IllegalArgumentException - если поддиапазон, заданный beginIndex и endIndex, выходит за пределы диапазона текста.

См. также:

Annotation

AttributedString

public AttributedString(AttributedCharacterIterator text,
                        int beginIndex,
                        int endIndex,
                        AttributedCharacterIterator.Attribute[] attributes)

Создаёт экземпляр AttributedString с подстрокой заданного атрибутированного текста, представленного AttributedCharacterIterator. Будут включены только атрибуты, соответствующие заданным атрибутам. Если заданный диапазон создаёт пустой текст, все атрибуты будут отброшены. Обратите внимание, что любые атрибуты, заключённые в объект Annotation, отбрасываются для поддиапазона исходного диапазона атрибутов.

Параметры:

text - Текст для этой атрибутированной строки.

beginIndex - Индекс первого символа диапазона.

endIndex - Индекс символа, следующего за последним символом диапазона.

attributes - Указывает атрибуты, подлежащие извлечению из текста. Если задано null, будут использованы все доступные атрибуты.

Исключения:

NullPointerException - если text равно null.

IllegalArgumentException - если поддиапазон, заданный beginIndex и endIndex, выходит за пределы диапазона текста.

См. также:

Annotation

Подробное описание методов

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute,
                         Object value)

Добавляет атрибут ко всей строке.

Параметры:

attribute - ключ атрибута

value - значение атрибута; может быть null

Исключения:

NullPointerException - если attribute равно null.

IllegalArgumentException - если у AttributedString длина 0 (атрибуты не могут быть применены к диапазону длиной 0).

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute,
                         Object value,
                         int beginIndex,
                         int endIndex)

Добавляет атрибут к подстроке.

Параметры:

attribute - ключ атрибута

value - Значение атрибута. Может быть null.

beginIndex - Индекс первого символа диапазона.

endIndex - Индекс символа, следующего за последним символом диапазона.

Исключения:

NullPointerException - если attribute равно null.

IllegalArgumentException - если beginIndex меньше 0, endIndex больше длины строки или beginIndex и endIndex вместе не определяют непустой поддиапазон строки.

addAttributes

public void addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes,
                          int beginIndex,
                          int endIndex)

Добавляет набор атрибутов к подстроке.

Параметры:

attributes - Атрибуты, которые должны быть добавлены в строку.

beginIndex - Индекс первого символа диапазона.

endIndex - Индекс символа, следующего за последним символом диапазона.

Исключения:

NullPointerException - если attributes равно null.

IllegalArgumentException - если beginIndex меньше 0, endIndex больше длины строки или beginIndex и endIndex вместе не определяют непустой поддиапазон строки и параметр attributes не является пустым Map.

getIterator

public AttributedCharacterIterator getIterator()

Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ ко всему содержимому этой строки.

Возвращает:

Итератор, предоставляющий доступ к тексту и его атрибутам.

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)

Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ к выбранному содержимому этой строки. Информация об атрибутах, не указанных в attributes, по усмотрению реализующего класса может не делаться доступной через итератор. Если список равен null, вся доступная информация об атрибутах должна быть доступна.

Параметры:

attributes - список атрибутов, которые интересуют клиента

Возвращает:

итератор, предоставляющий доступ к всему тексту и его выбранным атрибутам

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes,
                                               int beginIndex,
                                               int endIndex)

Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ к выбранному содержимому этой строки. Информация об атрибутах, не указанных в attributes, по усмотрению реализующего класса может не делаться доступной через итератор. Если список равен null, вся доступная информация об атрибутах должна быть доступна.

Параметры:

attributes - список атрибутов, которые интересуют клиента

beginIndex - индекс первого символа

endIndex - индекс символа, следующего за последним символом

Возвращает:

итератор, предоставляющий доступ к тексту и его атрибутам

Исключения:

IllegalArgumentException - если beginIndex меньше 0, endIndex больше длины строки или beginIndex больше endIndex.