Spec-Zone.ru › OpenJDK 21

Класс 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, 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/text/AbstractDocument.DefaultDocumentEvent.html

Spec-Zone.ru

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