Spec-Zone.ru › OpenJDK 8

Класс 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.

Spec-Zone.ru

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