Класс PlainDocument

public class PlainDocument
extends AbstractDocument

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

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

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

Поля

tabSizeAttribute

public static final String tabSizeAttribute

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

См. также:

Значения константных полей

lineLimitAttribute

public static final String lineLimitAttribute

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

См. также:

Значения константных полей

Конструкторы

PlainDocument

public PlainDocument()

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

PlainDocument

public PlainDocument(AbstractDocument.Content c)

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

Параметры:

c — контейнер для содержимого

Методы

insertString

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

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

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

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

insertString в классе AbstractDocument

Параметры:

offs — начальное смещение >= 0

str — строка для вставки; не выполняет никаких действий с нулевыми/пустыми строками

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

Исключения:

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

См. также:

Document.insertString(int, java.lang.String, javax.swing.text.AttributeSet)

getDefaultRootElement

public Element getDefaultRootElement()

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

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

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

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

getDefaultRootElement в классе AbstractDocument

Возвращает:

корень

См. также:

Document.getDefaultRootElement()

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 — событие изменения, описывающее вставку

attr — набор атрибутов для вставляемого текста

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

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

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

removeUpdate в классе AbstractDocument

Параметры:

chng — событие изменения, описывающее редактирование