Интерфейс StyledDocument

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

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

public interface StyledDocument extends Document

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

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

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

StreamDescriptionProperty, TitleProperty

Модификатор и тип	Поле	Описание
`static final String`	`StreamDescriptionProperty`	Имя свойства, содержащего описание потока, использованного для инициализации документа.
`static final String`	`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)`	Задает атрибуты абзаца.

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

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

Модификатор и тип	Метод	Описание
`void`	`addDocumentListener(DocumentListener listener)`	Регистрирует указанный объект-наблюдатель, чтобы он начал получать уведомления об изменениях в документе.
`void`	`addUndoableEditListener(UndoableEditListener listener)`	Регистрирует указанный объект-наблюдатель, чтобы он начал получать уведомления об изменениях, допускающих отмену, в документе.
`Position`	`createPosition(int offs)`	Этот метод позволяет приложению отметить позицию в последовательности символьного содержимого.
`Element`	`getDefaultRootElement()`	Возвращает корневой элемент, на котором должны основываться представления, если не предоставлен другой механизм сопоставления представлений со структурами элементов.
`Position`	`getEndPosition()`	Возвращает позицию, соответствующую концу документа.
`int`	`getLength()`	Возвращает количество символов содержимого, находящихся в данный момент в документе.
`Object`	`getProperty(Object key)`	Возвращает свойства, связанные с документом.
`Element[]`	`getRootElements()`	Возвращает все определенные корневые элементы.
`Position`	`getStartPosition()`	Возвращает позицию, соответствующую началу документа.
`String`	`getText(int offset, int length)`	Получает текст, содержащийся в указанной части документа.
`void`	`getText(int offset, int length, Segment txt)`	Получает текст, содержащийся в указанной части документа.
`void`	`insertString(int offset, String str, AttributeSet a)`	Вставляет строку содержимого.
`void`	`putProperty(Object key, Object value)`	Связывает свойство с документом.
`void`	`remove(int offs, int len)`	Удаляет часть содержимого документа.
`void`	`removeDocumentListener(DocumentListener listener)`	Удаляет указанный объект-наблюдатель из списка уведомлений, чтобы он больше не получал обновления об изменениях.
`void`	`removeUndoableEditListener(UndoableEditListener listener)`	Удаляет указанный объект-наблюдатель из списка уведомлений, чтобы он больше не получал обновления.
`void`	`render(Runnable r)`	Позволяет безопасно отображать модель при наличии параллельного выполнения, если модель поддерживает асинхронное обновление.

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

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 — атрибуты, на которые нужно заменить текущие; значение не должно быть null. Все определенные атрибуты будут применены к тексту в заданном диапазоне.; replace — указывает, следует ли очистить предыдущие атрибуты перед установкой новых. Если значение true, операция полностью заменяет предыдущие атрибуты. Если значение false, новые атрибуты объединяются с предыдущими.

setParagraphAttributes

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

Задает атрибуты абзаца.

Параметры:: offset — начало изменения >= 0; length — длина изменения >= 0; s — атрибуты, на которые нужно заменить текущие; значение не должно быть null. Все определенные атрибуты будут применены к тексту в заданном диапазоне.; 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.