java.text

Класс AttributedString

java.lang. Объект

java.text. AttributedString

public class AttributedString
extends Object

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

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

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

С тех пор:

1.2

См. Также:

AttributedCharacterIterator, Annotation

Сводка конструктора

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

Конструктор и Описание
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.
AttributedString(String text) Создает экземпляр AttributedString с данным текстом.
AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute,?> attributes) Создает экземпляр AttributedString с данным текстом и атрибутами.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
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 унаследованный от класса. Объект

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

Деталь конструктора

AttributedString

public AttributedString(String text)

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

Параметры:

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

Броски:

NullPointerException - если text нуль.

AttributedString

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

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

Параметры:

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

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

Броски:

NullPointerException - если text или attributes нуль.

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

AttributedString

public AttributedString(AttributedCharacterIterator text)

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

Параметры:

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

Броски:

NullPointerException - если text нуль.

AttributedString

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

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

Параметры:

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

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

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

Броски:

NullPointerException - если text нуль.

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

См. Также:

Annotation

AttributedString

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

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

Параметры:

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

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

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

attributes - Определяет атрибуты, которые будут извлечены из текста. Если нуль будет определен, то все доступные атрибуты будут использоваться.

Броски:

NullPointerException - если text нуль.

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

См. Также:

Annotation

Деталь метода

addAttribute

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

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

Параметры:

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

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

Броски:

NullPointerException - если attribute нуль.

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

addAttribute

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

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

Параметры:

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

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

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

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

Броски:

NullPointerException - если attribute нуль.

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

addAttributes

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

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

Параметры:

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

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

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

Броски:

NullPointerException - если attributes нуль.

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

getIterator

public AttributedCharacterIterator getIterator()

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

Возвраты:

iterator обеспечение доступа к тексту и его атрибутам.

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)

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

Параметры:

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

Возвраты:

iterator обеспечение доступа ко всему тексту и его выбранным атрибутам

getIterator

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

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

Параметры:

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

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

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

Возвраты:

iterator обеспечение доступа к тексту и его атрибутам

Броски:

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