Spec-Zone.ru › OpenJDK 8

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API