Класс AbstractDocument

java.lang.Object

javax.swing.text.AbstractDocument

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

Прямые известные подклассы:: DefaultStyledDocument, PlainDocument

public abstract class AbstractDocument extends Object implements Document, Serializable

Реализация интерфейса документа, предназначенная в качестве основы для реализации различных типов документов. На этом уровне существует очень мало политики, что соответствует увеличению сложности использования.

Этот класс реализует механизм блокировки для документа. Он позволяет нескольким читателям или одному писателю, и писатели должны дождаться, пока все наблюдатели документа не будут уведомлены о предыдущем изменении, прежде чем начать другую модификацию документа. Чтение блокировки приобретается и высвобождается с помощью метода render. Запись блокировки приобретается методами, которые изменяют документ, и удерживается на протяжении всего вызова метода. Уведомление выполняется в потоке, который произвел изменение, и поток имеет полный доступ для чтения к документу на период уведомления, но другие читатели остаются вне доступа до завершения уведомления. Уведомление — это уведомление об событии для бинов, которое не допускает дальнейших изменений, пока все слушатели не будут уведомлены.

Любые модели, являющиеся подклассами этого класса и используемые совместно с текстовым компонентом, который имеет реализацию внешнего вида, производную от BasicTextUI, могут быть безопасно обновлены асинхронно, поскольку весь доступ к иерархии представлений сериализован BasicTextUI, если документ имеет тип AbstractDocument. Блокировка предполагает, что отдельный поток будет обращаться к иерархии представлений только из методов DocumentListener и что в одно время будет активен только один поток событий.

Если требуется поддержка многопоточности, существуют следующие дополнительные последствия. Путь кода для любой реализации DocumentListener и любой реализации UndoListener должен быть потокобезопасным и не должен обращаться к блокировке компонента, если пытается избежать тупиков. Методы repaint и revalidate на JComponent безопасны.

AbstractDocument моделирует неявный разрыв в конце документа. Среди прочего это позволяет позиционировать курсор после последнего символа. В результате этого, getLength возвращает значение, на единицу меньшее, чем длина содержимого. Если вы создаёте собственное содержимое, убедитесь, что оно инициализировано с дополнительным символом. Обратитесь к StringContent и GapContent для примеров этого. Ещё одним следствием является то, что элементы, моделирующие неявный конечный символ, будут иметь endOffset == (getLength() + 1). Например, в DefaultStyledDocument getParagraphElement(getLength()).getEndOffset() == getLength() + 1.

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

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

Модификатор и тип	Класс	Описание
`class`	`AbstractDocument.AbstractElement`	Реализует абстрактную часть элемента.
`static interface`	`AbstractDocument.AttributeContext`	Интерфейс, который может использоваться для того, чтобы реализации MutableAttributeSet могли использовать подключаемые методы сжатия атрибутов.
`class`	`AbstractDocument.BranchElement`	Реализует составной элемент, содержащий другие элементы.
`static interface`	`AbstractDocument.Content`	Интерфейс для описания последовательности текстового содержимого, которое можно редактировать.
`class`	`AbstractDocument.DefaultDocumentEvent`	Хранит изменения документа во время его модификации.
`static class`	`AbstractDocument.ElementEdit`	Реализация ElementChange, которую можно добавить в событие документа.
`class`	`AbstractDocument.LeafElement`	Реализует элемент, который напрямую представляет содержимое определенного типа.

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

Модификатор и тип	Поле	Описание
`protected static final String`	`BAD_LOCATION`	Сообщение об ошибке, указывающее на неправильное расположение.
`static final String`	`BidiElementName`	Имя элементов, используемых для хранения однонаправленного блока.
`static final String`	`ContentElementName`	Имя элементов, используемых для представления содержимого.
`static final String`	`ElementNameAttribute`	Имя атрибута, используемого для указания имён элементов.
`protected EventListenerList`	`listenerList`	Список слушателей событий для документа.
`static final String`	`ParagraphElementName`	Имя элементов, используемых для представления абзацев.
`static final String`	`SectionElementName`	Имя элементов, используемых для представления разделов (строк/абзацев).

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

StreamDescriptionProperty, TitleProperty

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

AbstractDocument(AbstractDocument.Content data)

AbstractDocument(AbstractDocument.Content data,
 AbstractDocument.AttributeContext context)

Модификатор	Конструктор	Описание
`protected`	Создаёт новый `AbstractDocument`, обернутый вокруг некоторого указанного механизма хранения содержимого.
`protected`	Создаёт новый `AbstractDocument`, обернутый вокруг некоторого указанного механизма хранения содержимого.

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

Модификатор и тип	Метод	Описание
`void`	`addDocumentListener(DocumentListener listener)`	Добавляет слушателя документов для получения уведомлений о любых изменениях.
`void`	`addUndoableEditListener(UndoableEditListener listener)`	Добавляет слушателя отмены для получения уведомлений о любых изменениях.
`protected Element`	`createBranchElement(Element parent, AttributeSet a)`	Создаёт элемент ветви документа, который может содержать другие элементы.
`protected Element`	`createLeafElement(Element parent, AttributeSet a, int p0, int p1)`	Создаёт элемент листа документа.
`Position`	`createPosition(int offs)`	Возвращает позицию, которая будет отслеживать изменения по мере изменения документа.
`void`	`dump(PrintStream out)`	Выводит диагностический дамп.
`protected void`	`fireChangedUpdate(DocumentEvent e)`	Уведомляет всех слушателей, которые зарегистрировали интерес к получению уведомлений об этом типе события.
`protected void`	`fireInsertUpdate(DocumentEvent e)`	Уведомляет всех слушателей, которые зарегистрировали интерес к получению уведомлений об этом типе события.
`protected void`	`fireRemoveUpdate(DocumentEvent e)`	Уведомляет всех слушателей, которые зарегистрировали интерес к получению уведомлений об этом типе события.
`protected void`	`fireUndoableEditUpdate(UndoableEditEvent e)`	Уведомляет всех слушателей, которые зарегистрировали интерес к получению уведомлений об этом типе события.
`int`	`getAsynchronousLoadPriority()`	Получает асинхронный приоритет загрузки.
`protected final AbstractDocument.AttributeContext`	`getAttributeContext()`	Получает контекст для управления атрибутами.
`Element`	`getBidiRootElement()`	Возвращает корневой элемент двунаправленной структуры для этого документа.
`protected final AbstractDocument.Content`	`getContent()`	Получает содержимое документа.
`protected final Thread`	`getCurrentWriter()`	Получает текущую рабочую нить записи, если она есть.
`abstract Element`	`getDefaultRootElement()`	Возвращает корневой элемент, на котором должны основываться представления, если не предоставлен другой механизм для назначения представлений элементам структуры.
`DocumentFilter`	`getDocumentFilter()`	Возвращает `DocumentFilter`, отвечающий за фильтрацию вставки/удаления.
`DocumentListener[]`	`getDocumentListeners()`	Возвращает массив всех зарегистрированных слушателей документов в этом документе.
`Dictionary<Object,Object>`	`getDocumentProperties()`	Поддерживает управление набором свойств.
`final Position`	`getEndPosition()`	Возвращает позицию, представляющую конец документа.
`int`	`getLength()`	Возвращает длину данных.
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)`	Возвращает массив всех объектов, в настоящее время зарегистрированных как `FooListener` в этом документе.
`abstract Element`	`getParagraphElement(int pos)`	Получает элемент абзаца, содержащий заданную позицию.
`final Object`	`getProperty(Object key)`	Удобный метод для поиска значения свойства.
`Element[]`	`getRootElements()`	Получает все определённые корневые элементы.
`final Position`	`getStartPosition()`	Возвращает позицию, представляющую начало документа.
`String`	`getText(int offset, int length)`	Получает последовательность текста из документа.
`void`	`getText(int offset, int length, Segment txt)`	Получает текст, содержащийся в заданной части документа.
`UndoableEditListener[]`	`getUndoableEditListeners()`	Возвращает массив всех слушателей отменяемых редактирований, зарегистрированных в этом документе.
`void`	`insertString(int offs, String str, AttributeSet a)`	Вставляет некоторое содержимое в документ.
`protected void`	`insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)`	Обновляет структуру документа в результате вставки текста.
`protected void`	`postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng)`	Обновляет любую структуру документа в результате удаления текста.
`final void`	`putProperty(Object key, Object value)`	Удобный метод для хранения значения свойства.
`final void`	`readLock()`	Получает блокировку для начала чтения некоторых данных из документа.
`final void`	`readUnlock()`	Производит разблокировку чтения.
`void`	`remove(int offs, int len)`	Удаляет некоторое содержимое из документа.
`void`	`removeDocumentListener(DocumentListener listener)`	Удаляет слушателя документов.
`void`	`removeUndoableEditListener(UndoableEditListener listener)`	Удаляет слушателя отмены.
`protected void`	`removeUpdate(AbstractDocument.DefaultDocumentEvent chng)`	Обновляет любую структуру документа в результате удаления текста.
`void`	`render(Runnable r)`	Это позволяет модели безопасно отображаться при наличии валюты, если модель поддерживает асинхронное обновление.
`void`	`replace(int offset, int length, String text, AttributeSet attrs)`	Удаляет область текста от `offset` до `offset + length` и заменяет её на `text`.
`void`	`setAsynchronousLoadPriority(int p)`	Устанавливает асинхронный приоритет загрузки.
`void`	`setDocumentFilter(DocumentFilter filter)`	Устанавливает `DocumentFilter`.
`void`	`setDocumentProperties(Dictionary<Object,Object> x)`	Заменяет словарь свойств документа для этого документа.
`protected final void`	`writeLock()`	Получает блокировку для начала изменения документа, который защищает эта блокировка.
`protected final void`	`writeUnlock()`	Освобождает блокировку записи, ранее полученную через `writeLock`.

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

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

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

listenerList

protected EventListenerList listenerList

Список слушателей событий для документа.

BAD_LOCATION

protected static final String BAD_LOCATION

Сообщение об ошибке, указывающее на неправильное расположение.

См. также:

ParagraphElementName

public static final String ParagraphElementName

Имя элементов, используемых для представления абзацев

См. также:

ContentElementName

public static final String ContentElementName

Имя элементов, используемых для представления содержимого

См. также:

SectionElementName

public static final String SectionElementName

Имя элементов, используемых для размещения разделов (строк/абзацев).

См. также:

BidiElementName

public static final String BidiElementName

Имя элементов, используемых для размещения однонаправленного блока

См. также:

ElementNameAttribute

public static final String ElementNameAttribute

Имя атрибута, используемого для указания имён элементов.

См. также:

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

AbstractDocument

protected AbstractDocument(AbstractDocument.Content data)

Создаёт новый AbstractDocument, обернутый вокруг некоторого указанного механизма хранения содержимого.

Параметры:: data - содержимое

AbstractDocument

protected AbstractDocument(AbstractDocument.Content data, AbstractDocument.AttributeContext context)

Создаёт новый AbstractDocument, обернутый вокруг некоторого указанного механизма хранения содержимого.

Параметры:: data - содержимое; context - контекст атрибутов

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

getDocumentProperties

public Dictionary<Object,Object> getDocumentProperties()

Поддерживает управление набором свойств. Вызывающие стороны могут использовать словарь documentProperties для аннотирования документа свойствами, относящимися ко всему документу.

Возвращает:

не-null Dictionary

См. также:

setDocumentProperties

public void setDocumentProperties(Dictionary<Object,Object> x)

Заменяет словарь свойств документа для этого документа.

Параметры:

x - новый словарь

См. также:

fireInsertUpdate

protected void fireInsertUpdate(DocumentEvent e)

Уведомляет всех слушателей, которые зарегистрировали интерес к уведомлениям об этом типе события. Экземпляр события создаётся лениво с использованием параметров, переданных в метод fire.

Параметры:

e - событие

См. также:

fireChangedUpdate

protected void fireChangedUpdate(DocumentEvent e)

Параметры:

e - событие

См. также:

fireRemoveUpdate

protected void fireRemoveUpdate(DocumentEvent e)

Параметры:

e - событие

См. также:

fireUndoableEditUpdate

protected void fireUndoableEditUpdate(UndoableEditEvent e)

Параметры:

e - событие

См. также:

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Возвращает массив всех объектов, которые в данный момент зарегистрированы как FooListener в этом документе. FooListener регистрируются с помощью метода addFooListener.

Вы можете указать аргумент listenerType с помощью литерала класса, например, FooListener.class. Например, вы можете запросить слушателей документа в документе d с помощью следующего кода:

DocumentListener[] mls = (DocumentListener[])(d.getListeners(DocumentListener.class));

Если такие слушатели не существуют, этот метод возвращает пустой массив.

Параметры типа:

T - тип слушателя

Параметры:

listenerType - тип запрашиваемых слушателей

Возвращает:

массив всех объектов, зарегистрированных как FooListener на этом компоненте, или пустой массив, если такие слушатели не были добавлены

Исключения:

ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener

С:

1.3

См. также:

getAsynchronousLoadPriority

public int getAsynchronousLoadPriority()

Получает приоритет асинхронной загрузки. Если значение меньше нуля, документ не должен загружаться асинхронно.

Возвращает:: приоритет асинхронной загрузки или -1, если документ не должен загружаться асинхронно

setAsynchronousLoadPriority

public void setAsynchronousLoadPriority(int p)

Устанавливает приоритет асинхронной загрузки.

Параметры:: p - новый приоритет асинхронной загрузки; значение меньше нуля указывает, что документ не должен загружаться асинхронно

setDocumentFilter

public void setDocumentFilter(DocumentFilter filter)

Устанавливает DocumentFilter. DocumentFilter передаётся insert и remove, чтобы условно разрешить вставку/удаление текста. Значение null указывает, что фильтрация не будет выполняться.

Параметры:

filter - DocumentFilter, используемый для ограничения текста

С:

1.4

См. также:

getDocumentFilter

public DocumentFilter getDocumentFilter()

Возвращает DocumentFilter, который отвечает за фильтрацию вставки/удаления. Возврат null подразумевает отсутствие фильтрации.

Возвращает:

DocumentFilter

С:

1.4

См. также:

render

public void render(Runnable r)

Это позволяет безопасно отобразить модель при наличии валюты, если модель поддерживает асинхронное обновление. Указанный Runnable будет выполнен таким образом, чтобы он мог безопасно прочитать модель без изменений, пока выполняется Runnable. Сам Runnable не должен вносить никаких изменений.

Эта реализация приобретает чтение блокировки на время выполнения Runnable. Одновременно могут выполняться несколько Runnable, и все записывающие потоки будут заблокированы, пока активны потоки отображения. Если Runnable вызывает исключение, его блокировка будет безопасно освобождена. Нет защиты от Runnable, который никогда не завершается, что фактически оставит документ заблокированным на всё время его существования.

Если данный Runnable пытается внести какие-либо изменения в этой реализации, произойдет тупиковая ситуация. Нет отслеживания отдельных потоков отображения, чтобы можно было обнаружить эту ситуацию, но подкласс может понести издержки на отслеживание и выброс ошибки.

Этот метод потокобезопасен, хотя большинство методов Swing таковыми не являются. Для получения дополнительной информации см. Конкурентность в Swing.

Определено в:: render в интерфейсе Document
Параметры:: r - рендерер для выполнения

getLength

public int getLength()

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

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

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

Возвращает:

длину >= 0

См. также:

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Добавляет слушателя изменений документа для уведомления о любых изменениях.

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

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

Параметры:

listener - добавляемый слушатель DocumentListener

См. также:

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Удаляет слушателя изменений документа.

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

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

Параметры:

listener - удаляемый слушатель DocumentListener

См. также:

getDocumentListeners

public DocumentListener[] getDocumentListeners()

Возвращает массив всех зарегистрированных слушателей изменений документа.

Возвращает:

все слушатели DocumentListener данного документа или пустой массив, если слушатели не зарегистрированы

С:

1.4

См. также:

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Добавляет слушателя отмены/повтора для уведомления о любых изменениях. Операции отмены/повтора, выполненные над документом UndoableEdit, вызовут соответствующее событие DocumentEvent, чтобы синхронизировать представление(я) с моделью.

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

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

Параметры:

listener - добавляемый слушатель UndoableEditListener

См. также:

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Удаляет слушателя отмены/повтора.

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

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

Параметры:

listener - удаляемый слушатель UndoableEditListener

См. также:

getUndoableEditListeners

public UndoableEditListener[] getUndoableEditListeners()

Возвращает массив всех зарегистрированных слушателей изменений отмены/повтора.

Возвращает:

все слушатели UndoableEditListener данного документа или пустой массив, если слушатели не зарегистрированы

С:

1.4

См. также:

getProperty

public final Object getProperty(Object key)

Метод для поиска значения свойства. Он эквивалентен:

 getDocumentProperties().get(key);

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

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

Параметры:

key - ключ свойства, не являющегося null

Возвращает:

значение свойства или null

См. также:

putProperty

public final void putProperty(Object key, Object value)

Метод для сохранения значения свойства. Он эквивалентен:

 getDocumentProperties().put(key, value);

Если value является null, этот метод удалит свойство.

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

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

Параметры:

key - ключ свойства, не являющегося null

value - значение свойства

См. также:

remove

public void remove(int offs, int len) throws BadLocationException

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

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

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

Параметры:

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

len - количество удаляемых символов >= 0

Исключение:

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

См. также:

replace

public void replace(int offset, int length, String text, AttributeSet attrs) throws BadLocationException

Удаляет область текста с offset по offset + length и заменяет её на text. Реализация может трактовать это как две отдельные операции: удаление, за которым следует вставка, или как одну атомную операцию замены.

Параметры:: offset - индекс дочернего элемента; length - длина удаляемого текста, может быть 0, что указывает на отсутствие удаления; text - вставляемый текст, null указывает на отсутствие вставки текста; attrs - атрибуты вставляемого текста, null является допустимым и обычно рассматривается как пустой набор атрибутов, но точное толкование оставляется подклассу
Исключение:: BadLocationException - заданная позиция не является допустимой позицией в документе
С:: 1.4

insertString

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

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

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

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

Параметры:

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

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

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

Исключение:

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

См. также:

getText

public String getText(int offset, int length) throws BadLocationException

Получает последовательность текста из документа.

Specified by:

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

Parameters:

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

length - количество символов для извлечения >= 0

Returns:

текст

Throws:

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

See Also:

getText

public void getText(int offset, int length, Segment txt) throws BadLocationException

Извлекает текст, содержащийся в заданной части документа.

Если свойство partialReturn параметра txt равно false, возвращаемые в Segменте данные будут иметь полную запрошенную длину и могут быть или не быть копией в зависимости от того, как данные были сохранены. Если свойство partialReturn равно true, возвращается только то количество текста, которое может быть возвращено без создания копии. Использование частичных возвратов обеспечит лучшую производительность в ситуациях, когда сканируются большие части документа. Следующий пример демонстрирует использование частичного возврата для доступа к всему документу:

   int nleft = doc.getDocumentLength();
   Segment text = new Segment();
   int offs = 0;
   text.setPartialReturn(true);
   while (nleft > 0) {
       doc.getText(offs, nleft, text);
       // do something with text
       nleft -= text.count;
       offs += text.count;
   }

Specified by:: getText в интерфейсе Document
Parameters:: offset - начальный смещение >= 0; length - количество символов для извлечения >= 0; txt - объект Segment для извлечения текста
Throws:: BadLocationException - указанный диапазон включает позицию, которая не является допустимой позицией в документе

createPosition

public Position createPosition(int offs) throws BadLocationException

Возвращает позицию, которая будет отслеживать изменения по мере изменения документа.

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

Specified by:

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

Parameters:

offs - позиция в модели >= 0

Returns:

позиция

Throws:

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

See Also:

getStartPosition

public final Position getStartPosition()

Возвращает позицию, представляющую начало документа. Можно рассчитывать на то, что возвращаемая позиция будет отслеживать изменения и оставаться в начале документа.

Specified by:: getStartPosition в интерфейсе Document
Returns:: позиция

getEndPosition

public final Position getEndPosition()

Возвращает позицию, представляющую конец документа. Можно рассчитывать на то, что возвращаемая позиция будет отслеживать изменения и оставаться в конце документа.

Specified by:: getEndPosition в интерфейсе Document
Returns:: позиция

getRootElements

public Element[] getRootElements()

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

Specified by:: getRootElements в интерфейсе Document
Returns:: корневой элемент

getDefaultRootElement

public abstract Element getDefaultRootElement()

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

Specified by:

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

Returns:

корневой элемент

See Also:

getBidiRootElement

public Element getBidiRootElement()

Возвращает корневой элемент двунаправленной структуры для данного документа. Его дочерние элементы представляют собой пробелы символов с заданным уровнем Unicode bidi.

Returns:: корневой элемент двунаправленной структуры для данного документа

getParagraphElement

public abstract Element getParagraphElement(int pos)

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

Parameters:: pos - начальный смещение >= 0
Returns:: элемент

getAttributeContext

protected final AbstractDocument.AttributeContext getAttributeContext()

Получает контекст для управления атрибутами. Этот метод фактически устанавливает стратегию, используемую для сжатия информации AttributeSet.

Returns:: контекст

insertUpdate

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

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

Parameters:: chng - описание изменения; attr - атрибуты для изменения

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

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

Parameters:: chng - описание изменения

postRemoveUpdate

protected void postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng)

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

Parameters:: chng - описание изменения

dump

public void dump(PrintStream out)

Выводит диагностический дамп.

Parameters:: out - поток вывода

getContent

protected final AbstractDocument.Content getContent()

Получает содержимое документа.

Returns:: содержимое

createLeafElement

protected Element createLeafElement(Element parent, AttributeSet a, int p0, int p1)

Создаёт элемент листа документа. Точка входа, через которую создаются элементы для представления структуры документа. Поскольку эта реализация разделяет структуру и содержимое, элементы растут автоматически при расширении содержимого, поэтому разделение существующих элементов следует за этим. Сам документ решает, как генерировать элементы, чтобы обеспечить гибкость в использовании типов элементов.

Parameters:: parent - родительский элемент; a - атрибуты элемента; p0 - начало диапазона >= 0; p1 - конец диапазона >= p0
Returns:: новый элемент

createBranchElement

protected Element createBranchElement(Element parent, AttributeSet a)

Создаёт элемент ветви документа, который может содержать другие элементы.

Parameters:: parent - родительский элемент; a - атрибуты
Returns:: элемент

getCurrentWriter

protected final Thread getCurrentWriter()

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

Returns:: нить, активно изменяющая документ, или null, если нет текущих изменений

writeLock

protected final void writeLock()

Приобретает блокировку для начала изменения документа, который защищает эта блокировка. Не должно быть ни записи, ни уведомления о изменениях, ни чтения, чтобы получить блокировку. Кроме того, потоку разрешается получить более одной writeLock, если он не пытается получить дополнительные writeLock из уведомления о документе. Попытка получить writeLock из уведомления DocumentListener приведет к IllegalStateException. Возможность получения более одной writeLock на поток позволяет подклассам получить writeLock, выполнить ряд операций, а затем освободить блокировку.

Вызовы writeLock должны быть сбалансированы вызовами writeUnlock, иначе блокировка Document останется заблокированной, чтобы невозможно было выполнять чтение или запись.

Throws:: IllegalStateException - выбрасывается при неправомерной попытке блокировки. Если документ реализован должным образом, это может произойти только в том случае, если слушатель документа пытается изменить документ. Эта ситуация нарушает модель событий Bean, где порядок доставки не гарантируется, и все слушатели должны быть уведомлены перед дальнейшими изменениями.

writeUnlock

protected final void writeUnlock()

Освобождает блокировку записи, ранее полученную с помощью writeLock. После уменьшения счетчика блокировки, если нет ожидающих блокировок, это позволит новому записывателю или читателям.

См. также:

readLock

public final void readLock()

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

См. также:

readUnlock

public final void readUnlock()

Выполняет разблокировку чтения. Это сигнализирует о том, что один из читателей завершил работу. Если больше нет читателей, запись может снова начаться. Это должно быть сбалансировано с readLock и должно происходить в операторе finally, чтобы баланс был гарантирован. Ниже приведен пример.


     readLock();
     try {
         // do something
     } finally {
         readUnlock();
     }

См. также:

© 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/text/AbstractDocument.html