Интерфейс 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, 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/event/DocumentEvent.html