Интерфейс StyledDocument

Все суперинтерфейсы:: Document

Все известные реализующие классы:: DefaultStyledDocument, HTMLDocument

public interface StyledDocument extends Document

Интерфейс для обобщённого стилизованного документа.

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

Поля, объявленные в интерфейсе javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

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

Модификатор и тип	Метод	Описание
`Style`	`addStyle(String nm, Style parent)`	Добавляет новый стиль в иерархию логических стилей.
`Color`	`getBackground(AttributeSet attr)`	Преобразует набор атрибутов в спецификацию цвета фона.
`Element`	`getCharacterElement(int pos)`	Возвращает элемент, представляющий символ по заданному смещению в документе.
`Font`	`getFont(AttributeSet attr)`	Преобразует набор атрибутов в спецификацию шрифта.
`Color`	`getForeground(AttributeSet attr)`	Преобразует набор атрибутов в спецификацию цвета переднего плана.
`Style`	`getLogicalStyle(int p)`	Получает логический стиль для заданной позиции в абзаце.
`Element`	`getParagraphElement(int pos)`	Получает элемент, представляющий абзац, содержащий заданное смещение в документе.
`Style`	`getStyle(String nm)`	Получает именованный стиль, ранее добавленный в документ.
`void`	`removeStyle(String nm)`	Удаляет именованный стиль, ранее добавленный в документ.
`void`	`setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)`	Изменяет атрибуты элемента содержимого для заданного диапазона существующего содержимого в документе.
`void`	`setLogicalStyle(int pos, Style s)`	Устанавливает логический стиль для абзаца в заданной позиции.
`void`	`setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)`	Устанавливает атрибуты абзаца.

Методы, объявленные в интерфейсе javax.swing.text.Document

addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeDocumentListener, removeUndoableEditListener, render

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

addStyle

Style addStyle(String nm, Style parent)

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

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

removeStyle

void removeStyle(String nm)

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

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

getStyle

Style getStyle(String nm)

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

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

setCharacterAttributes

void setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)

Изменяет атрибуты элемента содержимого для заданного диапазона существующего содержимого в документе. Все атрибуты, определенные в переданном аргументе Attributes, применяются к заданному диапазону. Этот метод может использоваться для полного удаления всех атрибутов уровня содержимого для данного диапазона, передав аргумент Attributes без определённых атрибутов и установив replace в true.

Параметры:: offset - начало изменения >= 0; length - длина изменения >= 0; s - непустые атрибуты для изменения. Любые определенные атрибуты будут применены к тексту для данного диапазона.; replace - указывает, следует ли очистить предыдущие атрибуты перед установкой новых. Если true, операция полностью заменит предыдущие атрибуты. Если false, новые атрибуты будут объединены с предыдущими атрибутами.

setParagraphAttributes

void setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)

Устанавливает атрибуты абзаца.

Параметры:: offset - начало изменения >= 0; length - длина изменения >= 0; s - непустые атрибуты для изменения. Любые определенные атрибуты будут применены к тексту для данного диапазона.; replace - указывает, следует ли очистить предыдущие атрибуты перед установкой новых. Если true, операция полностью заменит предыдущие атрибуты. Если false, новые атрибуты будут объединены с предыдущими атрибутами.

setLogicalStyle

void setLogicalStyle(int pos, Style s)

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

Параметры:: pos - начальная позиция >= 0; s - стиль для установки

getLogicalStyle

Style getLogicalStyle(int p)

Получает логический стиль для заданной позиции в абзаце.

Параметры:: p - позиция >= 0
Возвращает:: стиль

getParagraphElement

Element getParagraphElement(int pos)

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

Параметры:: pos - смещение >= 0
Возвращает:: элемент

getCharacterElement

Element getCharacterElement(int pos)

Получает элемент, представляющий символ по заданному смещению в документе.

Параметры:: pos - смещение >= 0
Возвращает:: элемент

getForeground

Color getForeground(AttributeSet attr)

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

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

getBackground

Color getBackground(AttributeSet attr)

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

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

getFont

Font getFont(AttributeSet attr)

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

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

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/text/StyledDocument.html