Интерфейс DocumentEvent

Все известные реализующие классы:: AbstractDocument.DefaultDocumentEvent

public interface DocumentEvent

Интерфейс для уведомлений о изменениях документа. Предоставляет подробную информацию наблюдателям документа о том, как изменился документ. Он предоставляет общую информацию, такую как тип изменения и место его возникновения, а также более подробные структурные изменения (Какие элементы были вставлены и удалены).

См. также:

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

Модификатор и тип	Интерфейс	Описание
`static interface`	`DocumentEvent.ElementChange`	Описывает изменения, внесенные в конкретный элемент.
`static final class`	`DocumentEvent.EventType`	Перечисление типов событий документа

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

Модификатор и тип	Метод	Описание
`DocumentEvent.ElementChange`	`getChange(Element elem)`	Получает информацию о изменениях для данного элемента.
`Document`	`getDocument()`	Возвращает документ, который породил событие изменения.
`int`	`getLength()`	Возвращает длину изменения.
`int`	`getOffset()`	Возвращает смещение в документе от начала изменения.
`DocumentEvent.EventType`	`getType()`	Получает тип события.

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

getOffset

int getOffset()

Возвращает смещение в документе от начала изменения.

Возвращает:: смещение >= 0

getLength

int getLength()

Возвращает длину изменения.

Возвращает:: длина >= 0

getDocument

Document getDocument()

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

Возвращает:: документ

getType

DocumentEvent.EventType getType()

Получает тип события.

Возвращает:: тип

getChange

DocumentEvent.ElementChange getChange(Element elem)

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

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

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

Если дочерний элемент вставлен в родительский элемент, родительский элемент должен сообщить об изменении. Если в дочерний элемент также были вставлены элементы (внуки родителя), эти элементы не должны сообщать об изменениях.

Параметры:: elem - элемент
Возвращает:: информация об изменениях или null, если элемент не был изменён

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