Класс PlainDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

Все реализованные интерфейсы:: Serializable, Document

public class PlainDocument extends AbstractDocument

Простой документ, не поддерживающий атрибуты символов. Структура элементов по умолчанию для этого документа — это карта строк текста. Элемент, возвращаемый методом getDefaultRootElement, представляет собой карту строк, а каждый дочерний элемент — это строка. Эта модель не поддерживает атрибуты на уровне символов, но каждая строка может быть помечена произвольным набором атрибутов. Перевод строки в смещение и смещения в строку можно быстро выполнить, используя корневой элемент по умолчанию. Информация о структуре, содержащаяся в событиях DocumentEvent, сгенерированных в результате редактирования, укажет на изменения структуры строк.

Управление хранилищем содержимого по умолчанию выполняется с помощью реализации gapped буфера (GapContent). Она поддерживает редактирование достаточно больших документов с высокой эффективностью, когда правки являются непрерывными или сгруппированными, как это обычно и бывает.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для кратковременного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, добавлена поддержка долгосрочного хранения всех JavaBeans в пакете java.beans. Обратитесь к XMLEncoder.

См. также:

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в классе javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`lineLimitAttribute`	Имя атрибута, определяющего максимальную длину строки, если она ограничена.
`static final String`	`tabSizeAttribute`	Имя атрибута, определяющего размер табуляции для табуляции, содержащейся в содержимом.

Поля, объявленные в классе javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Поля, объявленные в интерфейсе javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Краткое описание конструкторов

Конструктор	Описание
`PlainDocument()`	Создаёт документ с простым текстом.
`PlainDocument(AbstractDocument.Content c)`	Создаёт документ с простым текстом.

Краткое описание методов

Модификатор и тип	Метод	Описание
`protected AbstractDocument.AbstractElement`	`createDefaultRoot()`	Создаёт корневой элемент, используемый для представления структуры документа по умолчанию.
`Element`	`getDefaultRootElement()`	Получает корневой элемент по умолчанию для модели документа.
`Element`	`getParagraphElement(int pos)`	Получает элемент абзаца, содержащий заданную позицию.
`void`	`insertString(int offs, String str, AttributeSet a)`	Вставляет содержимое в документ.
`protected void`	`insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)`	Обновляет структуру документа в результате вставки текста.
`protected void`	`removeUpdate(AbstractDocument.DefaultDocumentEvent chng)`	Обновляет структуру документа в результате удаления текста.

Методы, объявленные в классе javax.swing.text.AbstractDocument

addDocumentListener, 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, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

tabSizeAttribute

public static final String tabSizeAttribute

Имя атрибута, задающего размер табуляции для табуляций, содержащихся в контенте. Тип значения — целое число.

См. также:

lineLimitAttribute

public static final String lineLimitAttribute

Имя атрибута, задающего максимальную длину строки, если максимальная длина задана. Тип значения — целое число.

См. также:

Подробное описание конструкторов

PlainDocument

public PlainDocument()

Создает документ с простым текстом. Создается и устанавливается модель по умолчанию, использующая GapContent.

PlainDocument

public PlainDocument(AbstractDocument.Content c)

Создает документ с простым текстом. Создается корневой элемент по умолчанию, а размер табуляции устанавливается в 8.

Параметры:: c - контейнер для содержимого

Подробное описание методов

insertString

public void insertString(int offs, String str, AttributeSet a) throws BadLocationException

Вставляет содержимое в документ. Вставка содержимого вызывает захват записи блокировки, в то время как выполняются фактические изменения, за которым следует уведомление наблюдателям в потоке, который захватил блокировку записи.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Подробнее об этом см. Асинхронность в Swing.

Определено в:

insertString в интерфейсе Document

Переопределяет:

insertString в классе AbstractDocument

Параметры:

offs - начальный смещение >= 0

str - строка для вставки; ничего не делает с null/пустыми строками

a - атрибуты для вставляемого содержимого

Исключения:

BadLocationException - заданная позиция вставки не является допустимой позицией в документе

См. также:

getDefaultRootElement

public Element getDefaultRootElement()

Получает корневой элемент по умолчанию для модели документа.

Определено в:

getDefaultRootElement в интерфейсе Document

Определено в:

getDefaultRootElement в классе AbstractDocument

Возвращает:

корень

См. также:

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

Создает корневой элемент, используемый для представления структуры документа по умолчанию.

Возвращает:: базовый элемент

getParagraphElement

public Element getParagraphElement(int pos)

Получает элемент абзаца, содержащий заданную позицию. Поскольку этот документ моделирует только строки, он возвращает строку вместо этого.

Определено в:: getParagraphElement в классе AbstractDocument
Параметры:: pos - начальный смещение >= 0
Возвращает:: элемент

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)

Обновляет структуру документа в результате вставки текста. Это произойдет внутри блокировки записи. Поскольку этот документ просто отображает строки, мы обновляем карту строк.

Переопределяет:: insertUpdate в классе AbstractDocument
Параметры:: chng - событие изменения, описывающее dit; attr - набор атрибутов для вставленного текста

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

Обновляет любую структуру документа в результате удаления текста. Это произойдет внутри блокировки записи. Поскольку структура представляет собой карту строк, это просто проверяет, охватывает ли удаление строки. Если это так, две строки за пределами области удаления объединяются.

Переопределяет:: removeUpdate в классе AbstractDocument
Параметры:: chng - событие изменения, описывающее редактирование

© 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/PlainDocument.html