Класс DefaultStyledDocument
- Все реализованные интерфейсы:
-
Serializable,Document,StyledDocument
- Прямые известные подклассы:
HTMLDocument
public class DefaultStyledDocument extends AbstractDocument implements StyledDocument
Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, работающими с одной и той же версией Swing. С версии 1.4 добавлена поддержка долгосрочного хранения всех JavaBeans в пакете java.beans. См. XMLEncoder.
- См. также:
Краткое описание вложенных классов
| Модификатор и тип | Класс | Описание |
|---|---|---|
static class |
DefaultStyledDocument.AttributeUndoableEdit |
UndoableEdit, используемый для запоминания изменений AttributeSet для элемента. |
class |
DefaultStyledDocument.ElementBuffer |
Класс для управления изменениями в иерархии элементов. |
static class |
DefaultStyledDocument.ElementSpec |
Спецификация для построения элементов. |
protected class |
DefaultStyledDocument.SectionElement |
Корневой элемент по умолчанию для документа... отображает содержащиеся абзацы/строки. |
Вложенные классы/интерфейсы, объявленные в классе javax.swing.text.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 |
Размер буфера содержимого по умолчанию. |
Поля, объявленные в классе javax.swing.text.AbstractDocument
BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName
Поля, объявленные в интерфейсе javax.swing.text.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 |
Вставляет новые элементы в bulk. |
protected void |
insertUpdate |
Обновляет структуру документа в результате вставки текста. |
void |
removeDocumentListener |
Удаляет слушателя изменений документа. |
void |
removeElement |
Удаляет элемент из этого документа. |
void |
removeStyle |
Удаляет ранее добавленный стиль по имени из документа. |
protected void |
removeUpdate |
Обновляет структуру документа в результате удаления текста. |
void |
setCharacterAttributes |
Устанавливает атрибуты для части документа. |
void |
setLogicalStyle |
Устанавливает логический стиль для абзаца по заданной позиции. |
void |
setParagraphAttributes |
Устанавливает атрибуты для абзаца. |
protected void |
styleChanged |
Вызывается при изменении любого из стилей этого документа. |
Методы, объявленные в классе javax.swing.text.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
Методы, объявленные в классе java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Методы, объявленные в интерфейсе javax.swing.text.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, если предыдущие атрибуты должны быть заменены перед установкой новых атрибутов
Установить атрибуты абзаца
public void setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)
Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее см. Конкурентность в Swing.
- Указано в:
-
setParagraphAttributesв интерфейсеStyledDocument - Параметры:
-
offset- смещение в абзаце >= 0 -
length- количество затронутых символов >= 0 -
s- атрибуты -
replace- следует ли заменить существующие атрибуты или объединить их
Получить элемент абзаца
public Element getParagraphElement(int pos)
pos. Абзац состоит как минимум из одного дочернего элемента, который обычно является листом.- Указано в:
-
getParagraphElementв интерфейсеStyledDocument - Указано в:
-
getParagraphElementв классеAbstractDocument - Параметры:
-
pos- начальное смещение >= 0 - Возвращает:
- элемент
Получить элемент символа
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- описание изменения документа
создатьКорневойЭлемент
protected AbstractDocument.AbstractElement createDefaultRoot()
- Возвращает:
- базовый элемент
ПолучитьЦветТекста
public Color getForeground(AttributeSet attr)
- Указано в:
-
getForegroundв интерфейсеStyledDocument - Параметры:
-
attr- набор атрибутов - Возвращает:
- цвет
ПолучитьЦветФона
public Color getBackground(AttributeSet attr)
- Указано в:
-
getBackgroundв интерфейсеStyledDocument - Параметры:
-
attr- набор атрибутов - Возвращает:
- цвет
ПолучитьШрифт
public Font getFont(AttributeSet attr)
- Указано в:
-
getFontв интерфейсеStyledDocument - Параметры:
-
attr- набор атрибутов - Возвращает:
- шрифт
ИзменениеСтиля
protected void styleChanged(Style style)
- Параметры:
-
style- Измененный стиль.
ДобавитьСлушателяИзмененийДокумента
public void addDocumentListener(DocumentListener listener)
- Указано в:
-
addDocumentListenerв интерфейсеDocument - Переопределяет:
-
addDocumentListenerв классеAbstractDocument - Параметры:
-
listener- слушатель - См. также:
УдалитьСлушателяИзмененийДокумента
public void removeDocumentListener(DocumentListener listener)
- Указано в:
-
removeDocumentListenerв интерфейсеDocument - Переопределяет:
-
removeDocumentListenerв классеAbstractDocument - Параметры:
-
listener- слушатель - См. также:
© 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/DefaultStyledDocument.html