Интерфейс StyledDocument
- Все суперинтерфейсы:
Document
- Все известные реализующие классы:
DefaultStyledDocument, HTMLDocument
public interface StyledDocument extends Document
Интерфейс для документа с общим форматированием.
Краткое описание полей
Поля, объявленные в интерфейсе Document
StreamDescriptionProperty, TitleProperty
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Style |
addStyle |
Добавляет новый стиль в иерархию логических стилей. |
Color |
getBackground |
Преобразует набор атрибутов в описание цвета фона. |
Element |
getCharacterElement |
Возвращает элемент, представляющий символ по указанному смещению в документе. |
Font |
getFont |
Преобразует набор атрибутов в описание шрифта. |
Color |
getForeground |
Преобразует набор атрибутов в описание цвета переднего плана. |
Style |
getLogicalStyle |
Возвращает логический стиль для указанной позиции в абзаце. |
Element |
getParagraphElement |
Возвращает элемент, представляющий абзац, содержащий указанное смещение в документе. |
Style |
getStyle |
Возвращает ранее добавленный именованный стиль. |
void |
removeStyle |
Удаляет именованный стиль, ранее добавленный в документ. |
void |
setCharacterAttributes |
Изменяет атрибуты элемента содержимого для указанного диапазона существующего содержимого документа. |
void |
setLogicalStyle |
Устанавливает логический стиль для абзаца в указанной позиции. |
void |
setParagraphAttributes |
Устанавливает атрибуты абзаца. |
Методы, объявленные в интерфейсе 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— новые атрибуты, не равные 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/text/StyledDocument.html