Интерфейс 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 Object NameAttribute

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

static 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, 2020, 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/11/docs/api/java.desktop/javax/swing/text/AttributeSet.html

Spec-Zone .ru
спецификации, руководства, описания, API