Класс AbstractDocument.DefaultDocumentEvent

java.lang.Object
- javax.swing.undo.AbstractUndoableEdit
- - javax.swing.undo.CompoundEdit
  - - javax.swing.text.AbstractDocument.DefaultDocumentEvent

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

Закрывающий класс:: AbstractDocument

public class AbstractDocument.DefaultDocumentEvent
extends CompoundEdit
implements DocumentEvent

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

См. также:: Сериализованная форма

Вложенные классы

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

DocumentEvent.ElementChange, DocumentEvent.EventType

Поля

Поля, объявленные в классе javax.swing.undo.CompoundEdit

edits

Поля, объявленные в классе javax.swing.undo.AbstractUndoableEdit

RedoName, UndoName

Конструкторы

Конструктор	Описание
`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()`	Отменяет изменение.

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

canRedo, canUndo, die, end, isInProgress, lastEdit

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

replaceEdit

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

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

Конструкторы

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, если правка была добавлена
См. также:: UndoableEdit.addEdit(javax.swing.undo.UndoableEdit)

redo

public void redo()
          throws CannotRedoException

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

Определено в:: redo в интерфейсе UndoableEdit
Переопределяет:: redo в классе CompoundEdit
Использует исключение:: CannotRedoException - если изменение не может быть повторено
См. также:: AbstractUndoableEdit.canRedo()

undo

public void undo()
          throws CannotUndoException

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

Определено в:: undo в интерфейсе UndoableEdit
Переопределяет:: undo в классе CompoundEdit
Использует исключение:: CannotUndoException - если изменение не может быть отменено
См. также:: AbstractUndoableEdit.canUndo()

isSignificant

public boolean isSignificant()

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

Определено в:: isSignificant в интерфейсе UndoableEdit
Переопределяет:: isSignificant в классе CompoundEdit
Возвращает:: является ли событие значимым для целей отмены изменений
См. также:: UndoableEdit.isSignificant()

getPresentationName

public String getPresentationName()

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

Определено в:: getPresentationName в интерфейсе UndoableEdit
Переопределяет:: getPresentationName в классе CompoundEdit
Возвращает:: описание
См. также:: AbstractUndoableEdit.getUndoPresentationName(), AbstractUndoableEdit.getRedoPresentationName()

getUndoPresentationName

public String getUndoPresentationName()

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

Определено в:: getUndoPresentationName в интерфейсе UndoableEdit
Переопределяет:: getUndoPresentationName в классе CompoundEdit
Возвращает:: описание
См. также:: AbstractUndoableEdit.getPresentationName()

getRedoPresentationName

public String getRedoPresentationName()

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

Определено в:: getRedoPresentationName в интерфейсе UndoableEdit
Переопределяет:: getRedoPresentationName в классе CompoundEdit
Возвращает:: описание
См. также:: AbstractUndoableEdit.getPresentationName()

getType

public DocumentEvent.EventType getType()

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

Определено в:: getType в интерфейсе DocumentEvent
Возвращает:: тип события как DocumentEvent.EventType
См. также:: DocumentEvent.getType()

getOffset

public int getOffset()

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

Определено в:: getOffset в интерфейсе DocumentEvent
Возвращает:: смещение >= 0
См. также:: DocumentEvent.getOffset()

getLength

public int getLength()

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

Определено в:: getLength в интерфейсе DocumentEvent
Возвращает:: длину >= 0
См. также:: DocumentEvent.getLength()

getDocument

public Document getDocument()

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

Определено в:: getDocument в интерфейсе DocumentEvent
Возвращает:: документ
См. также:: DocumentEvent.getDocument()

getChange

public DocumentEvent.ElementChange getChange(Element elem)

Получает изменения для элемента.

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

© 1993, 2020, 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/11/docs/api/java.desktop/javax/swing/text/AbstractDocument.DefaultDocumentEvent.html