Интерфейс 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, 2023, 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/21/docs/api/java.desktop/javax/swing/text/StyledDocument.html