Класс AttributedString

java.lang.Object

java.text.AttributedString

public class AttributedString extends Object

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

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

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

С момента:

1.2

См. также:

Краткое описание конструкторов

Конструктор	Описание
`AttributedString(String text)`	Создаёт экземпляр AttributedString с заданным текстом.
`AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute,?> attributes)`	Создаёт экземпляр AttributedString с заданным текстом и атрибутами.
`AttributedString(AttributedCharacterIterator text)`	Создаёт экземпляр AttributedString с заданным атрибутированным текстом, представленным объектом AttributedCharacterIterator.
`AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex)`	Создаёт экземпляр AttributedString с заданным поддиапазоном атрибутированного текста, представленным объектом AttributedCharacterIterator.
`AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)`	Создаёт экземпляр AttributedString с заданным поддиапазоном атрибутированного текста, представленным объектом AttributedCharacterIterator.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value)`	Добавляет атрибут к всему строке.
`void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)`	Добавляет атрибут к поддиапазону строки.
`void`	`addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes, int beginIndex, int endIndex)`	Добавляет набор атрибутов к поддиапазону строки.
`AttributedCharacterIterator`	`getIterator()`	Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ ко всему содержимому этой строки.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes)`	Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ к выбранному содержимому этой строки.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)`	Создаёт экземпляр AttributedCharacterIterator, предоставляющий доступ к выбранному содержимому этой строки.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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)

Параметры:: attributes - список атрибутов, которые интересуют клиента; beginIndex - индекс первого символа; endIndex - индекс символа, следующего за последним символом
Возвращает:: итератор, обеспечивающий доступ к тексту и его атрибутам
Исключения:: IllegalArgumentException - если beginIndex меньше 0, endIndex больше длины строки или beginIndex больше endIndex.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/AttributedString.html