Класс DefaultStyledDocument
- Все реализованные интерфейсы:
Serializable, Document, StyledDocument
- Прямые известные подклассы:
HTMLDocument
public class DefaultStyledDocument extends AbstractDocument implements StyledDocument
Предупреждение: Сериализованные объекты этого класса несовместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, работающими с одной и той же версией Swing. Начиная с версии 1.4 в пакет java.beans добавлена поддержка долговременного хранения всех JavaBeans. См. XMLEncoder.
- См. также:
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
static class |
DefaultStyledDocument.AttributeUndoableEdit |
UndoableEdit, используемый для запоминания изменений AttributeSet элемента. |
class |
DefaultStyledDocument.ElementBuffer |
Класс для управления изменениями иерархии элементов. |
static class |
DefaultStyledDocument.ElementSpec |
Спецификация построения элементов. |
protected class |
DefaultStyledDocument.SectionElement |
Корневой элемент документа по умолчанию... отображает содержащиеся в нём абзацы/строки. |
Вложенные классы/интерфейсы, объявленные в классе AbstractDocument
AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
protected DefaultStyledDocument.ElementBuffer |
buffer |
Буфер элементов. |
static final int |
BUFFER_SIZE_DEFAULT |
Размер буфера исходного содержимого по умолчанию. |
Поля, объявленные в классе AbstractDocument
BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName
Поля, объявленные в интерфейсе Document
StreamDescriptionProperty, TitleProperty
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
DefaultStyledDocument() |
Создаёт документ со стилями по умолчанию. |
DefaultStyledDocument |
Создаёт документ со стилями. |
DefaultStyledDocument |
Создаёт документ со стилями, используя реализацию хранилища содержимого по умолчанию и общий набор стилей. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
addDocumentListener |
Добавляет прослушиватель документа для уведомления о любых изменениях. |
Style |
addStyle |
Добавляет новый стиль в иерархию логических стилей. |
protected void |
create |
Инициализирует документ в соответствии с заданной структурой элементов (то есть структурой, о которой сообщает метод getDefaultRootElement. |
protected AbstractDocument.AbstractElement |
createDefaultRoot() |
Создаёт корневой элемент, используемый для представления структуры документа по умолчанию. |
Color |
getBackground |
Получает цвет фона из набора атрибутов. |
Element |
getCharacterElement |
Получает элемент символа по позиции. |
Element |
getDefaultRootElement() |
Получает корневой элемент по умолчанию. |
Font |
getFont |
Получает шрифт из набора атрибутов. |
Color |
getForeground |
Получает цвет переднего плана из набора атрибутов. |
Style |
getLogicalStyle |
Получает логический стиль, назначенный абзацу, соответствующему заданной позиции. |
Element |
getParagraphElement |
Получает элемент абзаца по смещению pos. |
Style |
getStyle |
Получает ранее добавленный именованный стиль. |
Enumeration |
getStyleNames() |
Получает список имён стилей. |
protected void |
insert |
Вставляет новые элементы пакетом. |
protected void |
insertUpdate |
Обновляет структуру документа в результате вставки текста. |
void |
removeDocumentListener |
Удаляет прослушиватель документа. |
void |
removeElement |
Удаляет элемент из этого документа. |
void |
removeStyle |
Удаляет именованный стиль, ранее добавленный в документ. |
protected void |
removeUpdate |
Обновляет структуру документа в результате удаления текста. |
void |
setCharacterAttributes |
Задаёт атрибуты для части документа. |
void |
setLogicalStyle |
Задаёт логический стиль для абзаца в указанной позиции. |
void |
setParagraphAttributes |
Задаёт атрибуты абзаца. |
protected void |
styleChanged |
Вызывается при изменении любого стиля этого документа. |
Методы, объявленные в классе AbstractDocument
addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock
Методы, объявленные в классе Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Методы, объявленные в интерфейсе Document
addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render
Подробное описание полей
BUFFER_SIZE_DEFAULT
public static final int BUFFER_SIZE_DEFAULT
- См. также:
buffer
protected DefaultStyledDocument.ElementBuffer buffer
Подробное описание конструкторов
DefaultStyledDocument
public DefaultStyledDocument(AbstractDocument.Content c, StyleContext styles)
- Параметры:
-
c— контейнер содержимого -
styles— ресурсы и определения стилей, которыми могут совместно пользоваться документы
DefaultStyledDocument
public DefaultStyledDocument(StyleContext styles)
- Параметры:
-
styles— стили
DefaultStyledDocument
public DefaultStyledDocument()
Подробное описание методов
getDefaultRootElement
public Element getDefaultRootElement()
- Определено в:
-
getDefaultRootElementв интерфейсеDocument - Определено в:
-
getDefaultRootElementв классеAbstractDocument - Возвращает:
- корневой элемент
- См. также:
create
protected void create(DefaultStyledDocument.ElementSpec[] data)
getDefaultRootElement. Если документ содержит данные, они сначала удаляются.- Параметры:
-
data— данные элементов
insert
protected void insert(int offset, DefaultStyledDocument.ElementSpec[] data) throws BadLocationException
Этот метод потокобезопасен, хотя большинство методов Swing — нет. Дополнительные сведения см. в разделе Параллельность в Swing.
- Параметры:
-
offset— начальное смещение >= 0 -
data— данные элементов - Вызывает:
-
BadLocationException— если начальное смещение недопустимо
removeElement
public void removeElement(Element elem)
Элемент удаляется из родительского элемента, а также удаляется текст в диапазоне, заданном этим элементом. Если элемент не связан с документом, выбрасывается
IllegalArgumentException.
Поскольку пустые ветвящиеся элементы в документе не допускаются, если элемент является единственным дочерним элементом, его родительский элемент также удаляется рекурсивно. Это означает, что при замене всех дочерних элементов определённого элемента новые дочерние элементы следует добавлять до удаления старых.
При удалении элемента генерируются два события: DocumentEvent — при изменении структуры элементов и
UndoableEditEvent — при изменении содержимого документа.
Если элемент содержит маркер конца содержимого (последний символ
"\n" в документе), этот символ не удаляется; вместо этого предшествующий листовой элемент расширяется, чтобы включить его. Если последний листовой элемент уже заканчивается на "\n",, этот символ включается в удаляемое содержимое.
Если элемент является null,, выбрасывается NullPointerException. Если после удаления структура элементов станет недопустимой, например если элемент является корневым элементом документа, выбрасывается
IllegalArgumentException. Если текущая структура элементов недопустима, выбрасывается IllegalStateException.
- Параметры:
-
elem— удаляемый элемент - Вызывает:
-
NullPointerException— если элемент являетсяnull -
IllegalArgumentException— если элемент не удалось удалить -
IllegalStateException— если структура элементов недопустима - Начиная с версии:
- 1.7
addStyle
public Style addStyle(String nm, Style parent)
- Определено в:
-
addStyleв интерфейсеStyledDocument - Параметры:
-
nm— имя стиля (должно быть уникальным в коллекции именованных стилей). Имя может быть null, если стиль не имеет имени, но вызывающий код отвечает за управление возвращённой ссылкой, поскольку неименованный стиль нельзя получить по имени. Неименованный стиль может быть полезен, например, для переопределения атрибутов символов, как это бывает во фрагменте стиля. -
parent— родительский стиль. Может быть null, если для неопределённых атрибутов не требуется выполнять поиск в другом стиле. - Возвращает:
- стиль
removeStyle
public void removeStyle(String nm)
- Определено в:
-
removeStyleв интерфейсеStyledDocument - Параметры:
-
nm— имя удаляемого стиля
getStyle
public Style getStyle(String nm)
- Определено в:
-
getStyleв интерфейсеStyledDocument - Параметры:
-
nm— имя стиля - Возвращает:
- стиль
getStyleNames
public Enumeration<?> getStyleNames()
- Возвращает:
- все имена стилей
setLogicalStyle
public void setLogicalStyle(int pos, Style s)
Этот метод потокобезопасен, хотя большинство методов Swing — нет. Дополнительные сведения см. в разделе Параллельность в Swing.
- Определено в:
-
setLogicalStyleв интерфейсеStyledDocument - Параметры:
-
pos— смещение от начала документа >= 0 -
s— логический стиль, назначаемый абзацу; null, если стиль не задан
getLogicalStyle
public Style getLogicalStyle(int p)
- Определено в:
-
getLogicalStyleв интерфейсеStyledDocument - Параметры:
-
p— позиция для определения соответствующего абзаца и назначенного ему логического стиля >= 0. Это смещение от начала документа. - Возвращает:
- стиль или null, если он не задан
setCharacterAttributes
public void setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)
offset и length задают диапазон текста, для которого устанавливаются атрибуты. Если длина <= 0, действие не выполняется и метод просто возвращает управление. Если смещение <=0 или > длины текста, действие не выполняется и метод просто возвращает управление. В противном случае, если offset + length превышает длину текста, затрагиваемый диапазон усекается.
Этот метод потокобезопасен, хотя большинство методов Swing — нет. Дополнительные сведения см. в разделе Параллельность в Swing.
- Определено в:
-
setCharacterAttributesв интерфейсеStyledDocument - Параметры:
-
offset— смещение в документе >= 0 -
length— длина > 0 -
s— атрибуты -
replace— true, если перед установкой новых атрибутов следует заменить предыдущие
setParagraphAttributes
public void setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)
Этот метод потокобезопасен, хотя большинство методов Swing — нет. Дополнительные сведения см. в разделе Параллельность в Swing.
- Определено в:
-
setParagraphAttributesв интерфейсеStyledDocument - Параметры:
-
offset— смещение внутри абзаца >= 0 -
length— количество затрагиваемых символов >= 0 -
s— атрибуты -
replace— заменять ли существующие атрибуты или объединить их с новыми
getParagraphElement
public Element getParagraphElement(int pos)
pos. Абзац состоит как минимум из одного дочернего элемента Element, который обычно является листовым.- Определено в:
-
getParagraphElementв интерфейсеStyledDocument - Определено в:
-
getParagraphElementв классеAbstractDocument - Параметры:
-
pos— начальное смещение >= 0 - Возвращает:
- элемент
getCharacterElement
public Element getCharacterElement(int pos)
- Определено в:
-
getCharacterElementв интерфейсеStyledDocument - Параметры:
-
pos— позиция в документе >= 0 - Возвращает:
- элемент
insertUpdate
protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)
- Переопределяет:
-
insertUpdateв классеAbstractDocument - Параметры:
-
chng— описание изменения документа -
attr— атрибуты
removeUpdate
protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
- Переопределяет:
-
removeUpdateв классеAbstractDocument - Параметры:
-
chng— описание изменения документа
createDefaultRoot
protected AbstractDocument.AbstractElement createDefaultRoot()
- Возвращает:
- основу элемента
getForeground
public Color getForeground(AttributeSet attr)
- Определено в:
-
getForegroundв интерфейсеStyledDocument - Параметры:
-
attr— набор атрибутов - Возвращает:
- цвет
getBackground
public Color getBackground(AttributeSet attr)
- Определено в:
-
getBackgroundв интерфейсеStyledDocument - Параметры:
-
attr— набор атрибутов - Возвращает:
- цвет
getFont
public Font getFont(AttributeSet attr)
- Определено в:
-
getFontв интерфейсеStyledDocument - Параметры:
-
attr— набор атрибутов - Возвращает:
- шрифт
styleChanged
protected void styleChanged(Style style)
- Параметры:
-
style— изменившийся объект Style.
addDocumentListener
public void addDocumentListener(DocumentListener listener)
- Определено в:
-
addDocumentListenerв интерфейсеDocument - Переопределяет:
-
addDocumentListenerв классеAbstractDocument - Параметры:
-
listener— прослушиватель - См. также:
removeDocumentListener
public void removeDocumentListener(DocumentListener listener)
- Определено в:
-
removeDocumentListenerв интерфейсеDocument - Переопределяет:
-
removeDocumentListenerв классеAbstractDocument - Параметры:
-
listener— прослушиватель - См. также:
© 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/DefaultStyledDocument.html