Класс StyleContext

java.lang.Object

javax.swing.text.StyleContext

Все реализуемые интерфейсы:: Serializable, AbstractDocument.AttributeContext

Непосредственные известные подклассы:: StyleSheet

public class StyleContext extends Object implements Serializable, AbstractDocument.AttributeContext

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

Этот класс также обеспечивает эффективную поддержку небольших наборов атрибутов и сжимает их путём совместного использования и использования их неизменяемости. Поскольку многие стили дублируются, потенциал совместного использования значителен, а копии могут быть очень дешёвыми. Более крупные наборы уменьшают возможность совместного использования, и поэтому автоматически возвращаются к менее эффективной с точки зрения места реализации.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans была добавлена в пакет java.beans. Пожалуйста, обратитесь к XMLEncoder.

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

Модификатор и тип	Класс	Описание
`class`	`StyleContext.NamedStyle`	Коллекция атрибутов, обычно используемая для представления стилей символов и абзацев.
`class`	`StyleContext.SmallAttributeSet`	Этот класс хранит небольшое количество атрибутов в массиве.

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

Модификатор и тип	Поле	Описание
`static final String`	`DEFAULT_STYLE`	Имя, присваиваемое по умолчанию логическому стилю, прикреплённому к абзацам.

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

Конструктор	Описание
`StyleContext()`	Создаёт новый объект StyleContext.

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

Модификатор и тип	Метод	Описание
`AttributeSet`	`addAttribute(AttributeSet old, Object name, Object value)`	Добавляет атрибут к заданному набору и возвращает новый представительный набор.
`AttributeSet`	`addAttributes(AttributeSet old, AttributeSet attr)`	Добавляет набор атрибутов к элементу.
`void`	`addChangeListener(ChangeListener l)`	Добавляет слушателя для отслеживания добавления или удаления стилей.
`Style`	`addStyle(String nm, Style parent)`	Добавляет новый стиль в иерархию стилей.
`protected MutableAttributeSet`	`createLargeAttributeSet(AttributeSet a)`	Создаёт большой набор атрибутов, который должен жертвовать пространством во времени.
`protected StyleContext.SmallAttributeSet`	`createSmallAttributeSet(AttributeSet a)`	Создаёт компактный набор атрибутов, который может быть совместно использован.
`Color`	`getBackground(AttributeSet attr)`	Принимает набор атрибутов и преобразует его в спецификацию фонового цвета.
`ChangeListener[]`	`getChangeListeners()`	Возвращает массив всех `ChangeListener`s, добавленных в этот StyleContext с помощью addChangeListener().
`protected int`	`getCompressionThreshold()`	Возвращает максимальное количество пар ключ/значение, которые следует пытаться сжать в уникальные/неизменяемые наборы.
`static final StyleContext`	`getDefaultStyleContext()`	Возвращает контекст атрибутов по умолчанию, используемый всеми документами, которые не утруждают себя определением/поставкой собственного контекста.
`AttributeSet`	`getEmptySet()`	Получает пустой AttributeSet.
`Font`	`getFont(String family, int style, int size)`	Получает новый шрифт.
`Font`	`getFont(AttributeSet attr)`	Получает шрифт из набора атрибутов.
`FontMetrics`	`getFontMetrics(Font f)`	Возвращает метрики шрифта для шрифта.
`Color`	`getForeground(AttributeSet attr)`	Принимает набор атрибутов и преобразует его в спецификацию цвета переднего плана.
`static Object`	`getStaticAttribute(Object key)`	Возвращает объект, ранее зарегистрированный с помощью `registerStaticAttributeKey`.
`static Object`	`getStaticAttributeKey(Object key)`	Возвращает строку, с которой `key` будет зарегистрирован.
`Style`	`getStyle(String nm)`	Получает стиль с именем, ранее добавленный в документ.
`Enumeration<?>`	`getStyleNames()`	Получает имена определённых стилей.
`void`	`readAttributes(ObjectInputStream in, MutableAttributeSet a)`	Обработка атрибутов, специфичных для контекста, при чтении.
`static void`	`readAttributeSet(ObjectInputStream in, MutableAttributeSet a)`	Читает набор атрибутов из заданного потока входного объекта, который был ранее записан с помощью `writeAttributeSet`.
`void`	`reclaim(AttributeSet a)`	Возвращает набор, больше не используемый реализацией MutableAttributeSet.
`static void`	`registerStaticAttributeKey(Object key)`	Регистрирует объект в качестве статического объекта, используемого в качестве ключа в наборах атрибутов.
`AttributeSet`	`removeAttribute(AttributeSet old, Object name)`	Удаляет атрибут из набора.
`AttributeSet`	`removeAttributes(AttributeSet old, Enumeration<?> names)`	Удаляет набор атрибутов для элемента.
`AttributeSet`	`removeAttributes(AttributeSet old, AttributeSet attrs)`	Удаляет набор атрибутов для элемента.
`void`	`removeChangeListener(ChangeListener l)`	Удаляет слушателя, который отслеживал добавление или удаление стилей.
`void`	`removeStyle(String nm)`	Удаляет стиль с именем, ранее добавленный в документ.
`String`	`toString()`	Преобразует StyleContext в строку.
`void`	`writeAttributes(ObjectOutputStream out, AttributeSet a)`	Обработка атрибутов, специфичных для контекста, при записи.
`static void`	`writeAttributeSet(ObjectOutputStream out, AttributeSet a)`	Записывает набор атрибутов в заданный поток объекта для целей сериализации.

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

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

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

DEFAULT_STYLE

public static final String DEFAULT_STYLE

Имя, присваиваемое по умолчанию логическому стилю, прикреплённому к абзацам.

См. также:

Значения константных полей

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

StyleContext

public StyleContext()

Создаёт новый объект StyleContext.

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

getDefaultStyleContext

public static final StyleContext getDefaultStyleContext()

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

Возвращает:: контекст

addStyle

public Style addStyle(String nm, Style parent)

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

Параметры:: nm - имя стиля (должно быть уникальным в рамках коллекции именованных стилей в документе). Имя может быть null, если стиль безымянный, но вызывающая сторона отвечает за управление ссылкой, так как безымянный стиль не может быть получен по имени. Безымянный стиль может быть полезен для таких задач, как переопределение атрибутов символов, как в стиле пробега.; parent - родительский стиль. Может быть null, если атрибуты по умолчанию не должны разрешаться в другом стиле.
Возвращает:: созданный стиль

removeStyle

public void removeStyle(String nm)

Удаляет именованный стиль, ранее добавленный в документ.

Параметры:: nm - имя стиля для удаления

getStyle

public Style getStyle(String nm)

Получает именованный стиль, ранее добавленный в документ

Параметры:: nm - имя стиля
Возвращает:: стиль

getStyleNames

public Enumeration<?> getStyleNames()

Получает имена определённых стилей.

Возвращает:: список имён в виде перечисления

addChangeListener

public void addChangeListener(ChangeListener l)

Добавляет слушателя для отслеживания добавления или удаления стилей.

Параметры:: l - слушатель изменений

removeChangeListener

public void removeChangeListener(ChangeListener l)

Удаляет слушателя, который отслеживал добавление или удаление стилей.

Параметры:: l - слушатель изменений

getChangeListeners

public ChangeListener[] getChangeListeners()

Возвращает массив всех ChangeListener добавленных в этот StyleContext с помощью addChangeListener().

Возвращает:: все добавленные ChangeListener или пустой массив, если слушатели не были добавлены
С:: 1.4

getFont

public Font getFont(AttributeSet attr)

Получает шрифт из набора атрибутов. Это реализовано для попытки извлечения кешированного шрифта для данного AttributeSet, и если это не удаётся, особенности шрифта разрешаются, и шрифт извлекается из кеша шрифтов низкого уровня.

Параметры:: attr - набор атрибутов
Возвращает:: шрифт

getForeground

public Color getForeground(AttributeSet attr)

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

Параметры:: attr - набор атрибутов
Возвращает:: цвет

getBackground

public Color getBackground(AttributeSet attr)

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

Параметры:: attr - набор атрибутов
Возвращает:: цвет

getFont

public Font getFont(String family, int style, int size)

Получает новый шрифт. Это возвращает шрифт из кеша, если такой шрифт существует. Если нет, шрифт добавляется в кеш. Это в основном кеш для функций шрифтов 1.1.

Параметры:: family - семейство шрифтов (например, "Monospaced"); style - стиль шрифта (например, Font.PLAIN); size - размер шрифта >= 1
Возвращает:: новый шрифт

getFontMetrics

public FontMetrics getFontMetrics(Font f)

Возвращает метрики шрифта для шрифта.

Параметры:: f - шрифт
Возвращает:: метрики

addAttribute

public AttributeSet addAttribute(AttributeSet old, Object name, Object value)

Добавляет атрибут к заданному набору и возвращает новый представительный набор.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Потоки в Swing.

Определено в:

addAttribute в интерфейсе AbstractDocument.AttributeContext

Параметры:

old - старый набор атрибутов

name - имя атрибута (не null)

value - значение атрибута

Возвращает:

обновлённый набор атрибутов

См. также:

MutableAttributeSet.addAttribute(java.lang.Object, java.lang.Object)

addAttributes

public AttributeSet addAttributes(AttributeSet old, AttributeSet attr)

Добавляет набор атрибутов к элементу.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Потоки в Swing.

Определено в:

addAttributes в интерфейсе AbstractDocument.AttributeContext

Параметры:

old - старый набор атрибутов

attr - добавляемые атрибуты

Возвращает:

обновлённый набор атрибутов

См. также:

MutableAttributeSet.addAttribute(java.lang.Object, java.lang.Object)

removeAttribute

public AttributeSet removeAttribute(AttributeSet old, Object name)

Удаляет атрибут из набора.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Потоки в Swing.

Определено в:

removeAttribute в интерфейсе AbstractDocument.AttributeContext

Параметры:

old - старый набор атрибутов

name - имя атрибута (не null)

Возвращает:

обновлённый набор атрибутов

См. также:

MutableAttributeSet.removeAttribute(java.lang.Object)

removeAttributes

public AttributeSet removeAttributes(AttributeSet old, Enumeration<?> names)

Удаляет набор атрибутов для элемента.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Потоки в Swing.

Определено в:

removeAttributes в интерфейсе AbstractDocument.AttributeContext

Параметры:

old - старый набор атрибутов

names - имена атрибутов

Возвращает:

обновлённый набор атрибутов

См. также:

MutableAttributeSet.removeAttributes(java.util.Enumeration<?>)

removeAttributes

public AttributeSet removeAttributes(AttributeSet old, AttributeSet attrs)

Удаляет набор атрибутов для элемента.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Потоки в Swing.

Определено в:

removeAttributes в интерфейсе AbstractDocument.AttributeContext

Параметры:

old - старый набор атрибутов

attrs - атрибуты

Возвращает:

обновлённый набор атрибутов

См. также:

MutableAttributeSet.removeAttributes(java.util.Enumeration<?>)

getEmptySet

public AttributeSet getEmptySet()

Получает пустой набор AttributeSet.

Определено в:: getEmptySet в интерфейсе AbstractDocument.AttributeContext
Возвращает:: набор

reclaim

public void reclaim(AttributeSet a)

Возвращает набор, больше не нужный реализации MutableAttributeSet. Это полезно для работы под 1.1, где нет слабых ссылок. Обычно вызывается методом finalize реализации MutableAttributeSet.

Этот метод потокобезопасен, хотя большинство методов Swing не являются таковыми. Подробности см. в Конкурентность в Swing.

Указано в:: reclaim в интерфейсе AbstractDocument.AttributeContext
Параметры:: a - набор для возврата

getCompressionThreshold

protected int getCompressionThreshold()

Возвращает максимальное количество пар ключ/значение, которые нужно попробовать сжать в уникальные/неизменяемые наборы. Все наборы, превышающие этот предел, будут использовать хэш-таблицы и являться MutableAttributeSet.

Возвращает:: порог

createSmallAttributeSet

protected StyleContext.SmallAttributeSet createSmallAttributeSet(AttributeSet a)

Создает компактный набор атрибутов, который может быть общим. Это служебный метод для подклассов, которые хотят изменить поведение SmallAttributeSet. Его можно переопределить, чтобы вернуть AttributeSet, обеспечивающий какой-либо вид преобразования атрибутов.

Параметры:: a - Набор атрибутов, который должен быть представлен в компактной форме.
Возвращает:: компактный набор атрибутов, который может быть общим

createLargeAttributeSet

protected MutableAttributeSet createLargeAttributeSet(AttributeSet a)

Создает большой набор атрибутов, который должен жертвовать пространством ради скорости. Этот набор не будет общим. Это служебный метод для подклассов, которые хотят изменить поведение формата хранения больших атрибутов (который по умолчанию является SimpleAttributeSet). Его можно переопределить, чтобы вернуть MutableAttributeSet, обеспечивающий какой-либо вид преобразования атрибутов.

Параметры:: a - Набор атрибутов, который должен быть представлен в большем формате.
Возвращает:: большой набор атрибутов, который должен жертвовать пространством ради скорости

toString

public String toString()

Преобразует StyleContext в строку.

Переопределяет:: toString в классе Object
Возвращает:: строку

writeAttributes

public void writeAttributes(ObjectOutputStream out, AttributeSet a) throws IOException

Обработка записи атрибутов, специфичная для контекста.

Параметры:: out - поток вывода; a - набор атрибутов
Исключения:: IOException - при любой ошибке ввода/вывода

readAttributes

public void readAttributes(ObjectInputStream in, MutableAttributeSet a) throws ClassNotFoundException, IOException

Обработка чтения атрибутов, специфичная для контекста.

Параметры:: in - поток объекта для чтения данных атрибутов.; a - набор атрибутов для размещения определений атрибутов.
Исключения:: ClassNotFoundException - передается вверх, если возникает при чтении потока объекта.; IOException - передается вверх, если возникает при чтении потока объекта.

writeAttributeSet

public static void writeAttributeSet(ObjectOutputStream out, AttributeSet a) throws IOException

Записывает набор атрибутов в указанный поток объекта для целей сериализации. Будет уделено особое внимание обработке статических ключей атрибутов, зарегистрированных методом registerStaticAttributeKey. Любой ключ атрибута, не зарегистрированный как статический ключ, будет сериализован напрямую. Все значения должны быть сериализуемы.

Параметры:: out - поток вывода; a - набор атрибутов
Исключения:: IOException - при любой ошибке ввода/вывода

readAttributeSet

public static void readAttributeSet(ObjectInputStream in, MutableAttributeSet a) throws ClassNotFoundException, IOException

Читает набор атрибутов из указанного потока входного объекта, которые были предварительно записаны методом writeAttributeSet. Попытается восстановить ключи, которые были статическими объектами, в статические объекты текущей виртуальной машины, учитывая только те ключи, которые были зарегистрированы методом registerStaticAttributeKey. Атрибуты, полученные из потока, будут помещены в указанный изменяемый набор.

Параметры:: in - поток объекта для чтения данных атрибутов.; a - набор атрибутов для размещения определений атрибутов.
Исключения:: ClassNotFoundException - передается вверх, если возникает при чтении потока объекта.; IOException - передается вверх, если возникает при чтении потока объекта.

registerStaticAttributeKey

public static void registerStaticAttributeKey(Object key)

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

Для работы в виртуальной машине 1.1 используется значение, возвращаемое toString, конкатенированное с именем класса. Значение, возвращаемое методом toString, не должно содержать ссылку на класс (то есть оно должно быть переопределено из определения в Object), чтобы оно было одинаковым при повторном вычислении позже.

Параметры:: key - непустой ключевой объект

getStaticAttribute

public static Object getStaticAttribute(Object key)

Возвращает объект, ранее зарегистрированный методом registerStaticAttributeKey.

Параметры:: key - ключевой объект
Возвращает:: Возвращает ранее зарегистрированный объект методом registerStaticAttributeKey

getStaticAttributeKey

public static Object getStaticAttributeKey(Object key)

Возвращает строку, с которой будет зарегистрирован key.

Параметры:

key - ключевой объект

Возвращает:

строку, с которой будет зарегистрирован key

См. также:

getStaticAttribute(java.lang.Object)
registerStaticAttributeKey(java.lang.Object)

© 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/StyleContext.html