Интерфейс AttributeSet

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

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

public interface AttributeSet

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

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

См. также:

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

Модификатор и тип	Интерфейс	Описание
`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, 2023, 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/21/docs/api/java.desktop/javax/swing/text/AttributeSet.html