Интерфейс 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, если стиль неименован, но вызывающий объект отвечает за управление ссылкой, поскольку неименованный стиль не может быть получен по имени. Неименованный стиль может быть полезен для таких задач, как переопределения атрибутов символов, как это встречается в стиле run. -
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, 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/StyledDocument.html
