Spec-Zone.ru › OpenJDK 17

Интерфейс DocumentEvent

Все известные реализующие классы:
AbstractDocument.DefaultDocumentEvent
public interface DocumentEvent
Интерфейс для уведомлений о изменениях документа. Предоставляет подробную информацию наблюдателям за документом о том, как изменился документ. Предоставляет информацию высокого уровня, такую как тип изменения и место его возникновения, а также более подробные структурные изменения (Какие элементы были вставлены и удалены).
См. также:
  • Document
  • DocumentListener

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

Модификатор и тип Интерфейс Описание
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, 2021, 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/17/docs/api/java.desktop/javax/swing/event/DocumentEvent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API