Интерфейс AttributeSet

Все известные подинтерфейсы:: MutableAttributeSet, Style

Все известные реализующие классы:: AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement, SimpleAttributeSet, StyleContext.NamedStyle, StyleContext.SmallAttributeSet

public interface AttributeSet

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

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

См. также:

MutableAttributeSet

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static interface`	`AttributeSet.CharacterAttribute`	Этот интерфейс определяет тип, который ожидается от любого ключа атрибута, влияющего на представление на уровне символов.
`static interface`	`AttributeSet.ColorAttribute`	Этот интерфейс определяет тип, который ожидается от любого ключа атрибута, влияющего на представление цвета.
`static interface`	`AttributeSet.FontAttribute`	Этот интерфейс определяет тип, который ожидается от любого ключа атрибута, влияющего на выбор шрифта для отображения текста.
`static interface`	`AttributeSet.ParagraphAttribute`	Этот интерфейс определяет тип, который ожидается от любого ключа атрибута, влияющего на представление абзаца.

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final Object`	`NameAttribute`	Имя атрибута, используемое для наименования коллекции атрибутов.
`static final Object`	`ResolveAttribute`	Имя атрибута, используемое для идентификации набора родительских атрибутов для разрешения, если таковой определён.

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

Модификатор и тип	Метод	Описание
`boolean`	`containsAttribute(Object name, Object value)`	Возвращает `true`, если этот набор определяет атрибут с тем же именем и равным значением.
`boolean`	`containsAttributes(AttributeSet attributes)`	Возвращает `true`, если этот набор определяет все атрибуты из данного набора с одинаковыми значениями.
`AttributeSet`	`copyAttributes()`	Возвращает набор атрибутов, гарантированно не изменяющийся со временем.
`Object`	`getAttribute(Object key)`	Извлекает значение заданного атрибута.
`int`	`getAttributeCount()`	Возвращает количество локально определённых атрибутов в этом наборе.
`Enumeration<?>`	`getAttributeNames()`	Возвращает перечисление имён локально определённых атрибутов в наборе.
`AttributeSet`	`getResolveParent()`	Получает родительский элемент для разрешения.
`boolean`	`isDefined(Object attrName)`	Проверяет, указан ли атрибут с заданным именем в наборе, не решая его через другой набор атрибутов.
`boolean`	`isEqual(AttributeSet attr)`	Определяет, эквивалентны ли два набора атрибутов.

Подробное описание полей

NameAttribute

static final Object NameAttribute

Имя атрибута, используемое для наименования коллекции атрибутов.

ResolveAttribute

static final Object ResolveAttribute

Имя атрибута, используемое для идентификации набора родительских атрибутов для разрешения, если таковой определён.

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

getAttributeCount

int getAttributeCount()

Возвращает количество локально определённых атрибутов в этом наборе. Атрибуты, определённые в родительском наборе, не включаются.

Возвращает:: количество атрибутов >= 0

isDefined

boolean isDefined(Object attrName)

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

Параметры:: attrName - имя атрибута
Возвращает:: true, если атрибут имеет указанное значение

isEqual

boolean isEqual(AttributeSet attr)

Определяет, эквивалентны ли два набора атрибутов.

Параметры:: attr - набор атрибутов
Возвращает:: true, если наборы эквивалентны

copyAttributes

AttributeSet copyAttributes()

Возвращает набор атрибутов, гарантированно не изменяющийся со временем.

Возвращает:: копию набора атрибутов

getAttribute

Object getAttribute(Object key)

Извлекает значение заданного атрибута. Если значение не найдено локально, поиск продолжается вверх по иерархии родительского элемента для разрешения (если он существует) до тех пор, пока значение не будет найдено или не останется больше родителей. Если значение не найдено, возвращается null.

Параметры:: key - не нулевой ключ связывания атрибута
Возвращает:: значение атрибута или null, если не найдено

getAttributeNames

Enumeration<?> getAttributeNames()

Возвращает перечисление имён локально определённых атрибутов в наборе. Имена атрибутов, определённых в родительском элементе для разрешения (если таковой есть), не включаются. Значения Enumeration могут быть любыми и не ограничены определённым типом Object.

Этот метод никогда не возвращает null. Для набора без атрибутов он возвращает пустое Enumeration.

Возвращает:: имена

containsAttribute

boolean containsAttribute(Object name, Object value)

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

Параметры:: name - не нулевое имя атрибута; value - значение
Возвращает:: true если набор определяет атрибут с равным значением, либо локально, либо через родителя для разрешения
Исключения:: NullPointerException - если либо name, либо value равно null

containsAttributes

boolean containsAttributes(AttributeSet attributes)

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

Параметры:: attributes - набор атрибутов для проверки
Возвращает:: true если этот набор определяет все атрибуты с равными значениями, либо локально, либо через родителя для разрешения
Исключения:: NullPointerException - если attributes равно null

getResolveParent

AttributeSet getResolveParent()

Получает родительский элемент для разрешения.

Возвращает:: родительский элемент

© 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.desktop/javax/swing/text/AttributeSet.html