javax.swing.undo

Interface UndoableEdit

所有已知实现类：

AbstractDocument.DefaultDocumentEvent， AbstractDocument.ElementEdit， AbstractUndoableEdit， CompoundEdit， DefaultStyledDocument.AttributeUndoableEdit， StateEdit， UndoManager

public interface UndoableEdit

一个 UndoableEdit代表编辑。编辑可能破灭，或者已经撤消编辑可以重做。

UndoableEdit是设计用来与UndoManager。作为UndoableEdits由UndoableEditListener通常添加到UndoManager生成。当一个UndoableEdit加入以下发生UndoManager（假设end没有呼吁UndoManager）：

1. 如果UndoManager包含编辑它会调用当前编辑过的新编辑作为论据addEdit。如果addEdit返回新的编辑被认为已被纳入当前的编辑和编辑将不会被添加到当前列表编辑。编辑可以使用addEdit对于较小的编辑被纳入更大的编辑和视为一个单一的编辑方式。
2. 如果addEdit返回false replaceEdit是呼吁新的编辑与当前编辑作为参数传入。如果新的编辑从replaceEdit返回true，这是addEdit—逆，新编辑替换当前编辑。

的 UndoManager利用 isSignificant确定多少的修改应撤消或重做。的 UndoManager将撤消或重做所有微不足道的编辑（ isSignificant返回false）之间目前的编辑和最后一个或下一个重要的编辑。 addEdit和 replaceEdit可用于治疗多种编辑作为一个编辑，返回FALSE isSignificant允许治疗可用于有许多小编辑撤消或重做一次。类似的功能还可以使用 addEdit方法。

方法摘要

Modifier and Type	Method and Description
boolean	addEdit(UndoableEdit anEdit) 增加了一个 UndoableEdit这 UndoableEdit。
boolean	canRedo() 如果这个编辑可能重新返回true。
boolean	canUndo() 如果此编辑可能撤消，则返回真。
void	die() 通知编辑，它不应该再使用。
String	getPresentationName() 返回一个本地化的，人类可读的描述这个编辑，适合在变化日志中使用，例如。
String	getRedoPresentationName() 返回一个局部的，这样的redoable形成人类可读的描述编辑，适合用作重做菜单项，例如。
String	getUndoPresentationName() 返回一个局部的撤消表人类可读的描述编辑，适合用作撤消菜单项，例如。
boolean	isSignificant() 如果此编辑被认为是显着的回报。
void	redo() 重新应用编辑。
boolean	replaceEdit(UndoableEdit anEdit) 如果这 UndoableEdit应该取代 anEdit返回true。
void	undo() 撤消编辑。

方法详细信息

undo

void undo()
   throws CannotUndoException

撤消编辑。

异常

CannotUndoException如果编辑无法复原

canUndo

boolean canUndo()

如果此编辑可能撤消，则返回真。

结果

如果此编辑可能撤消，则为

redo

void redo()
   throws CannotRedoException

重新应用编辑。

异常

CannotRedoException如果编辑不能重来

canRedo

boolean canRedo()

如果这个编辑可能重新返回true。

结果

如果这可以重新编辑

die

void die()

通知编辑，它不应该再使用。一旦 UndoableEdit已标记为死不能撤消或重做。

这是清理国家不再需要一旦撤消或重做是不可能的--比如一个有用的钩子，删除，无法删除对象文件资源。UndoManager称这才取出编辑。

请注意，这是一个单向操作。没有“联合死亡”的方法。

另请参见：

CompoundEdit.die()

addEdit

boolean addEdit(UndoableEdit anEdit)

增加了一个 UndoableEdit这 UndoableEdit。此方法可用于合并成一个较大的复合小编辑编辑。例如，文本编辑器通常允许撤消操作应用于单词或句子。文本编辑器可以选择生成编辑每个关键事件，但让那些编辑被合并成一个更人性化的装置，如一个词。在这种情况下，该 UndoableEdit将重写 addEdit返回true时，编辑可以合并。

一个真正的返回值表示anEdit纳入这个编辑。一个虚假的返回值指示anEdit不得纳入本编辑。

通常情况下，接收机已经是一个UndoManager队列（或其他UndoableEditListener），并有机会将anEdit而不是让它被添加到在打开队列。

如果真的是回来了，从现在开始anEdit必须假从canUndo和canRedo回报，必须把undo或redo适当的例外。

参数

anEdit -编辑要添加

结果

如果 anEdit可以并入本编辑

replaceEdit

boolean replaceEdit(UndoableEdit anEdit)

如果这 UndoableEdit应该取代 anEdit返回true。这种方法是通过 CompoundEdit和 UndoManager使用；如果 anEdit无法添加到当前编辑称为（ addEdit返回false）。

此方法提供了一种编辑替换现有编辑的方法。

这个消息是addedit相反-- anedit通常已经在UndoManager排队（或其他undoableeditlistener），和接收器被给予一个机会来代替。

如果真的是回来了，从现在开始anedit必须假从canundo()和canredo()回报，必须把undo()或redo()适当的例外。

参数

anEdit -编辑替换当前编辑

结果

如果这个编辑应该取代 anEdit

isSignificant

boolean isSignificant()

如果此编辑被认为是显着的回报。一个重要的编辑通常是一个编辑应该呈现给用户，或者在菜单项或工具提示。的 UndoManager将撤消或重做，所有微不足道的编辑，到下一个重要的编辑。

结果

如果这个编辑是重要的

getPresentationName

String getPresentationName()

返回一个本地化的，人类可读的描述这个编辑，适合在变化日志中使用，例如。

结果

这个编辑的描述

getUndoPresentationName

String getUndoPresentationName()

返回一个局部的撤消表人类可读的描述编辑，适合用作撤消菜单项，例如。这通常是来自 getPresentationName。

结果

描述这种撤消编辑表单

getRedoPresentationName

String getRedoPresentationName()

返回一个局部的，这样的redoable形成人类可读的描述编辑，适合用作重做菜单项，例如。这通常是来自 getPresentationName。

结果

描述这redoable形式编辑