Интерфейс 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, 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/StyledDocument.html