Класс AbstractDocument.DefaultDocumentEvent

javax.swing.text.AbstractDocument.DefaultDocumentEvent

Все реализуемые интерфейсы:: Serializable, DocumentEvent, UndoableEdit

Внешний класс:: AbstractDocument

public class AbstractDocument.DefaultDocumentEvent extends CompoundEdit implements DocumentEvent

Сохраняет изменения документа по мере его модификации. После завершения транзакции модификации документа эти данные можно использовать для уведомления об изменениях. Класс AbstractDocument и его расширения используют этот класс для рассылки сведений об изменениях слушателям документа.

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

Вложенные классы и интерфейсы, объявленные в интерфейсе DocumentEvent

DocumentEvent.ElementChange, DocumentEvent.EventType

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

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

Поля, объявленные в классе CompoundEdit

edits

Модификатор и тип	Поле	Описание
`protected Vector<UndoableEdit>`	`edits`	Коллекция `UndoableEdit`, которые отменяются или повторно применяются одновременно этим объектом `CompoundEdit`.

Поля, объявленные в классе AbstractUndoableEdit

RedoName, UndoName

Модификатор и тип	Поле	Описание
`protected static final String`	`RedoName`	Строка, возвращаемая методом `getRedoPresentationName`; начиная с платформы Java 2 версии 1.3.1 это поле больше не используется.
`protected static final String`	`UndoName`	Строка, возвращаемая методом `getUndoPresentationName`; начиная с платформы Java 2 версии 1.3.1 это поле больше не используется.

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

Конструктор	Описание
`DefaultDocumentEvent(int offs, int len, DocumentEvent.EventType type)`	Создаёт запись об изменении.

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

Модификатор и тип	Метод	Описание
`boolean`	`addEdit(UndoableEdit anEdit)`	Добавляет изменение документа.
`DocumentEvent.ElementChange`	`getChange(Element elem)`	Возвращает изменения элемента.
`Document`	`getDocument()`	Возвращает документ, вызвавший событие изменения.
`int`	`getLength()`	Возвращает длину изменения.
`int`	`getOffset()`	Возвращает смещение начала изменения в документе.
`String`	`getPresentationName()`	Предоставляет локализованное, понятное человеку описание этого изменения, подходящее, например, для журнала изменений.
`String`	`getRedoPresentationName()`	Предоставляет локализованное, понятное человеку описание формы этого изменения, которую можно повторно применить, например для пункта меню «Повторить».
`DocumentEvent.EventType`	`getType()`	Возвращает тип события.
`String`	`getUndoPresentationName()`	Предоставляет локализованное, понятное человеку описание отменяемой формы этого изменения, например для пункта меню «Отменить».
`boolean`	`isSignificant()`	События DefaultDocument имеют значение.
`void`	`redo()`	Повторно применяет изменение.
`String`	`toString()`	Возвращает строковое описание события изменения.
`void`	`undo()`	Отменяет изменение.

Методы, объявленные в классе CompoundEdit

canRedo, canUndo, die, end, isInProgress, lastEdit

Модификатор и тип	Метод	Описание
`boolean`	`canRedo()`	Возвращает false, если `isInProgress` или если super возвращает false.
`boolean`	`canUndo()`	Возвращает false, если `isInProgress` или если super возвращает false.
`void`	`die()`	Вызывает `die` для каждой вложенной правки в порядке, обратном порядку их добавления.
`void`	`end()`	Устанавливает для `inProgress` значение false.
`boolean`	`isInProgress()`	Возвращает true, если эта правка выполняется, то есть для неё ещё не был вызван метод end.
`protected UndoableEdit`	`lastEdit()`	Возвращает последнюю `UndoableEdit` в `edits` или `null`, если `edits` пуста.

Методы, объявленные в классе AbstractUndoableEdit

replaceEdit

Модификатор и тип	Метод	Описание
`boolean`	`replaceEdit(UndoableEdit anEdit)`	В данной реализации по умолчанию возвращается false.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Приостанавливает выполнение текущего потока до его пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Приостанавливает выполнение текущего потока до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Приостанавливает выполнение текущего потока до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

DefaultDocumentEvent

public DefaultDocumentEvent(int offs, int len, DocumentEvent.EventType type)

Создаёт запись об изменении.

Параметры:: offs — смещение изменения в документе >= 0; len — длина изменения >= 0; type — тип события (DocumentEvent.EventType)
С версии:: 1.4

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

toString

public String toString()

Возвращает строковое описание события изменения.

Переопределяет:: toString в классе CompoundEdit
Возвращает:: строку

addEdit

public boolean addEdit(UndoableEdit anEdit)

Добавляет изменение документа. Если число изменений превышает пороговое значение, включается поиск по хеш-таблице для реализаций ElementChange, поскольку к ним необходимо обращаться достаточно быстро.

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

addEdit в интерфейсе UndoableEdit

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

addEdit в классе CompoundEdit

Параметры:

anEdit — запись об изменении документа

Возвращает:

true, если изменение было добавлено

См. также:

redo

public void redo() throws CannotRedoException

Повторно применяет изменение.

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

redo в интерфейсе UndoableEdit

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

redo в классе CompoundEdit

Выбрасывает:

CannotRedoException — если изменение невозможно повторно применить

См. также:

undo

public void undo() throws CannotUndoException

Отменяет изменение.

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

undo в интерфейсе UndoableEdit

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

undo в классе CompoundEdit

Выбрасывает:

CannotUndoException — если изменение невозможно отменить

См. также:

isSignificant

public boolean isSignificant()

События DefaultDocument имеют значение. Если вы хотите объединить события DefaultDocument и представить их пользователю как одно изменение, поместите их в CompoundEdit.

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

isSignificant в интерфейсе UndoableEdit

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

isSignificant в классе CompoundEdit

Возвращает:

указывает, имеет ли событие значение для отмены изменения

См. также:

getPresentationName

public String getPresentationName()

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

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

getPresentationName в интерфейсе UndoableEdit

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

getPresentationName в классе CompoundEdit

Возвращает:

описание

См. также:

getUndoPresentationName

public String getUndoPresentationName()

Предоставляет локализованное, понятное человеку описание отменяемой формы этого изменения, например для пункта меню «Отменить». Обычно формируется на основе getDescription();

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

getUndoPresentationName в интерфейсе UndoableEdit

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

getUndoPresentationName в классе CompoundEdit

Возвращает:

описание

См. также:

getRedoPresentationName

public String getRedoPresentationName()

Предоставляет локализованное, понятное человеку описание формы этого изменения, которую можно повторно применить, например для пункта меню «Повторить». Обычно формируется на основе getPresentationName();

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

getRedoPresentationName в интерфейсе UndoableEdit

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

getRedoPresentationName в классе CompoundEdit

Возвращает:

описание

См. также:

getType

public DocumentEvent.EventType getType()

Возвращает тип события.

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

getType в интерфейсе DocumentEvent

Возвращает:

тип события в виде DocumentEvent.EventType

См. также:

getOffset

public int getOffset()

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

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

getOffset в интерфейсе DocumentEvent

Возвращает:

смещение >= 0

См. также:

getLength

public int getLength()

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

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

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

Возвращает:

длина >= 0

См. также:

getDocument

public Document getDocument()

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

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

getDocument в интерфейсе DocumentEvent

Возвращает:

документ

См. также:

getChange

public DocumentEvent.ElementChange getChange(Element elem)

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

Определено в:: getChange в интерфейсе DocumentEvent
Параметры:: elem — элемент
Возвращает:: изменения

© 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.