UndoManager (Java Platform SE 8 )

java.lang.Object
- javax.swing.undo.AbstractUndoableEdit
- - javax.swing.undo.CompoundEdit
  - - javax.swing.undo.UndoManager

All Implemented Interfaces:

Serializable ， EventListener ， UndoableEditListener ， UndoableEdit
```
public class UndoManager
extends CompoundEdit
implements UndoableEditListener
```
UndoManager管理列表UndoableEdits ，提供了一种方法来撤消或恢复适当的编辑。有两种方法可以向UndoManager添加编辑。使用addEdit方法直接添加编辑，或者将UndoManager添加到支持UndoableEditListener的bean。以下示例创建一个UndoManager ，并将其添加为UndoableEditListener至JTextField ：
```
  UndoManager undoManager = new UndoManager();
   JTextField tf = ...;
   tf.getDocument().addUndoableEditListener(undoManager); 
```
UndoManager维护编辑的有序列表和该列表中下一个编辑的索引。下一个编辑的索引或者编辑当前列表的大小，或者如果undo已被调用它对应于被撤销的最后显著编辑的索引。当调用undo时，所有从下一个编辑的索引到最后一个有效编辑的编辑将以相反的顺序撤消。例如，考虑由UndoManager编辑组成的UndoManager： A b D。粗体大写字母的编辑是重要的，小写和斜体的编辑是微不足道的。

Figure 1

如figure 1所示，如果刚刚添加了D ，则下一次编辑的索引将为4.调用undo导致在D上调用undo ，并将下一个编辑的索引设置为3（编辑c ），如下图所示。

Figure 2

最后一个重要的编辑是A ，所以调用undo再次调用c ，和A上的undo ，将下一个编辑的索引设置为0，如下图所示。

Figure 3

调用redo导致对下一个编辑的索引和下一个重要编辑（或列表的结尾）之间的所有编辑调用redo 。继续前面的例子，如果redo被调用， redo将依次在A ， b和c上被调用。另外下一个编辑的索引设置为3（如figure 2所示）。

将编辑添加到UndoManager会导致将下一次编辑的索引中的所有编辑从列表的末尾删除。继续前面的例子，如果添加了一个新的编辑，则编辑D从列表中删除（在其die调用die之后）。如果下一个编辑没有并入c （ c.addEdit(e)返回true），或者替换为（ e.replaceEdit(c)返回true），则在c之后添加新的编辑，如下图所示。

Figure 4

一旦end被调用了一个UndoManager超级行为被用于所有UndoableEdit方法。有关其行为的更多细节，请参阅CompoundEdit 。

与其他Swing不同，这个类是线程安全的。

警告：此类的序列化对象与将来的Swing版本不兼容。当前的序列化支持适用于运行相同版本的Swing的应用程序之间的短期存储或RMI。从1.4开始，对所有JavaBeans的长期存储的支持已经添加到java.beans包中。请参阅XMLEncoder 。

Field Summary
- Fields inherited from class javax.swing.undo.CompoundEdit
  edits
- Fields inherited from class javax.swing.undo.AbstractUndoableEdit
  RedoName, UndoName

构造方法摘要

构造方法
Constructor and Description
`UndoManager()` 创建一个新的 `UndoManager` 。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`boolean`	`addEdit(UndoableEdit anEdit)` 添加一个 `UndoableEdit`到这个 `UndoManager` ，如果可能的话。
`boolean`	`canRedo()` 如果编辑可能会重做，则返回true。
`boolean`	`canUndo()` 如果编辑可能被撤销，则返回true。
`boolean`	`canUndoOrRedo()` 如果可以调用 `undo`或 `redo`则返回true。
`void`	`discardAllEdits()` 清空撤销管理器，发送每个编辑一个 `die`消息的过程。
`protected UndoableEdit`	`editToBeRedone()` 返回如果要重做的下一个显著编辑 `redo`被调用。
`protected UndoableEdit`	`editToBeUndone()` 返回如果要撤消的显著编辑 `undo`被调用。
`void`	`end()` 把这 `UndoManager`变成一个正常的 `CompoundEdit` 。
`int`	`getLimit()` 返回此 `UndoManager`保留的最大编辑 `UndoManager` 。
`String`	`getRedoPresentationName()` 返回此修改的可重写形式的描述。
`String`	`getUndoOrRedoPresentationName()` 方便方法返回 `getUndoPresentationName`或 `getRedoPresentationName` 。
`String`	`getUndoPresentationName()` 返回此修改的可撤销形式的描述。
`void`	`redo()` 重新进行适当的编辑。
`protected void`	`redoTo(UndoableEdit edit)` 将下一次编辑索引的所有更改重新设置为 `edit` ， `edit`更新下一次编辑的索引。
`void`	`setLimit(int l)` 设置 `UndoManager`所持 `UndoManager`最大编辑 `UndoManager` 。
`String`	`toString()` 返回显示和标识此对象属性的字符串。
`protected void`	`trimEdits(int from, int to)` 删除指定范围内的编辑。
`protected void`	`trimForLimit()` 将排队的编辑数减少到大小限制的范围，以下一个编辑的索引为中心。
`void`	`undo()` 撤消相应的编辑。
`void`	`undoableEditHappened(UndoableEditEvent e)` 一个 `UndoableEditListener`方法。
`void`	`undoOrRedo()` 调用 `undo`或 `redo`之一的方便方法。
`protected void`	`undoTo(UndoableEdit edit)` 将下一次编辑索引的所有更改从 `edit` ，更新下一次编辑的索引。

Methods inherited from class javax.swing.undo.CompoundEdit
die, getPresentationName, isInProgress, isSignificant, lastEdit

Methods inherited from class javax.swing.undo.AbstractUndoableEdit
replaceEdit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造方法详细信息
  - UndoManager
```
public UndoManager()
```
    创建一个新的 UndoManager 。
- 方法详细信息
  - getLimit
```
public int getLimit()
```
    返回此UndoManager所持UndoManager最大编辑UndoManager 。小于0的值表示编辑次数不受限制。
    
    结果
    
    这个 UndoManager拥有的最大编辑 UndoManager
    
    另请参见：
    
    addEdit(javax.swing.undo.UndoableEdit) ， setLimit(int)
  - discardAllEdits
```
public void discardAllEdits()
```
    在 die管理器中清空发送每个编辑 die消息的过程。
    
    另请参见：
    
    AbstractUndoableEdit.die()
  - trimForLimit
```
protected void trimForLimit()
```
    将排队的编辑数减少到大小限制的范围，以下一个编辑的索引为中心。
  - trimEdits
```
protected void trimEdits(int from,
                         int to)
```
    删除指定范围内的编辑。给定范围内的所有编辑（包括和相反的顺序）将调用die并从编辑列表中删除。如果from > to 。
    
    参数
    
    from - 要移除的最小索引
    
    to - 要删除的最大索引
  - setLimit
```
public void setLimit(int l)
```
    设置此UndoManager保留的最大编辑数。小于0的值表示编辑次数不受限制。如果编辑需要丢弃以缩小限制， die将按照它们添加的相反顺序被调用。默认值为100。
    
    参数
    
    l - 新的限制
    
    异常
    
    RuntimeException - 如果这个 UndoManager未在进行中（ end已被调用）
    
    另请参见：
    
    CompoundEdit.isInProgress() ， end() ， addEdit(javax.swing.undo.UndoableEdit) ， getLimit()
  - editToBeUndone
```
protected UndoableEdit editToBeUndone()
```
    返回如果要撤消的显著编辑undo被调用。如果没有编辑被撤销，则返回null 。
    
    结果
    
    下一个重要的编辑将被撤销
  - editToBeRedone
```
protected UndoableEdit editToBeRedone()
```
    如果调用redo ，则返回下一个要重做的重要编辑。如果没有编辑重做，则返回null 。
    
    结果
    
    下一个要重做的重要编辑
  - undoTo
```
protected void undoTo(UndoableEdit edit)
               throws CannotUndoException
```
    将下一次编辑索引的所有更改从 edit ，更新下一次编辑的索引。
    
    异常
    
    CannotUndoException - 如果其中一个编辑投掷 CannotUndoException
  - redoTo
```
protected void redoTo(UndoableEdit edit)
               throws CannotRedoException
```
    将下一个编辑索引的所有更改重新设置为 edit ， edit更新下一个编辑的索引。
    
    异常
    
    CannotRedoException - 如果其中一个编辑投掷 CannotRedoException
  - undoOrRedo
```
public void undoOrRedo()
                throws CannotRedoException,
                       CannotUndoException
```
    调用undo或redo之一的方便方法。如果任何编辑已被撤销（下一个编辑的索引小于编辑列表的长度），则调用redo ，否则调用undo 。
    
    异常
    
    CannotUndoException - 如果其中一个编辑投掷 CannotUndoException
    
    CannotRedoException - 如果其中一个编辑投掷 CannotRedoException
    
    另请参见：
    
    canUndoOrRedo() ， getUndoOrRedoPresentationName()
  - canUndoOrRedo
```
public boolean canUndoOrRedo()
```
    如果可以调用 undo或 redo则返回true。
    
    结果
    
    如果调用 canUndoOrRedo有效，则为true
    
    另请参见：
    
    undoOrRedo()
  - undo
```
public void undo()
          throws CannotUndoException
```
    撤消相应的编辑。如果end已援引这一要求贯穿到超，否则该调用undo上的下一个编辑的索引和最后显著编辑之间的所有编辑，适当地更新下一个编辑的索引。
    
    Specified by:
    
    undo在接口 UndoableEdit
    
    重写：
    
    undo在 CompoundEdit
    
    异常
    
    CannotUndoException - 如果其中一个编辑投掷 CannotUndoException或没有编辑被撤销
    
    另请参见：
    
    CompoundEdit.end() ， canUndo() ， editToBeUndone()
  - canUndo
```
public boolean canUndo()
```
    如果编辑可能被撤销，则返回true。如果调用了end ，则返回超值的值。否则，如果有任何编辑被撤销，则返回true（ editToBeUndone返回非null ）。
    
    Specified by:
    
    canUndo在接口 UndoableEdit
    
    重写：
    
    canUndo在 CompoundEdit
    
    结果
    
    如果编辑被撤销，则为true
    
    另请参见：
    
    CompoundEdit.canUndo() ， editToBeUndone()
  - redo
```
public void redo()
          throws CannotRedoException
```
    重新进行适当的编辑。如果调用了end ，则调用该超类。否则，将对下一个编辑的索引和下一个重要编辑之间的所有编辑调用redo ，适当地更新下一个编辑的索引。
    
    Specified by:
    
    redo在界面 UndoableEdit
    
    重写：
    
    redo在类 CompoundEdit
    
    异常
    
    CannotRedoException - 如果其中一个编辑投掷 CannotRedoException或没有编辑重做
    
    另请参见：
    
    CompoundEdit.end() ， canRedo() ， editToBeRedone()
  - canRedo
```
public boolean canRedo()
```
    如果编辑可能会重做，则返回true。如果调用了end ，则返回超值的值。否则，如果有任何编辑要重做，则返回true（ editToBeRedone返回非null ）。
    
    Specified by:
    
    canRedo在接口 UndoableEdit
    
    重写：
    
    canRedo在 CompoundEdit
    
    结果
    
    如果编辑被重做，则为true
    
    另请参见：
    
    CompoundEdit.canRedo() ， editToBeRedone()
  - addEdit
```
public boolean addEdit(UndoableEdit anEdit)
```
    添加UndoableEdit到这个UndoManager ，如果可能的话。这会将下一次编辑的索引中的所有编辑从编辑列表的末尾删除。如果调用了end ，则不会添加编辑，并返回false 。如果end尚未被调用，则返回true 。
    
    Specified by:
    
    addEdit在界面 UndoableEdit
    
    重写：
    
    addEdit在 CompoundEdit
    
    参数
    
    anEdit - 要添加的编辑
    
    结果
    
    如果 anEdit可以并入此编辑，则为true
    
    另请参见：
    
    CompoundEdit.end() ， CompoundEdit.addEdit(javax.swing.undo.UndoableEdit)
  - end
```
public void end()
```
    把这UndoManager变成一个正常的CompoundEdit 。这将删除所有已被撤销的编辑。
    
    重写：
    
    end在 CompoundEdit
    
    另请参见：
    
    CompoundEdit.end()
  - getUndoOrRedoPresentationName
```
public String getUndoOrRedoPresentationName()
```
    方便方法返回getUndoPresentationName或getRedoPresentationName 。如果下一个编辑的索引等于编辑列表的大小， getUndoPresentationName返回，否则getRedoPresentationName返回。
    
    结果
    
    撤消或重做名称
  - getUndoPresentationName
```
public String getUndoPresentationName()
```
    返回此修改的可撤销形式的描述。如果end被调用，这个调用进入超级。否则，如果编辑被撤销，则返回下一个将被撤消的重要编辑的值。如果没有编辑被end并且没有调用end ，则返回UIManager属性“AbstractUndoableEdit.undoText”的值。
    
    Specified by:
    
    getUndoPresentationName在接口 UndoableEdit
    
    重写：
    
    getUndoPresentationName在 CompoundEdit
    
    结果
    
    该编辑的可撤销形式的描述
    
    另请参见：
    
    undo() ， CompoundEdit.getUndoPresentationName()
  - getRedoPresentationName
```
public String getRedoPresentationName()
```
    返回此修改的可重写形式的描述。如果end被调用，这个调用进入超级。否则，如果编辑被重做，则返回重新编辑的下一个重要编辑的值。如果没有重做编辑，并且未调用end ，则返回UIManager属性“AbstractUndoableEdit.redoText”的值。
    
    Specified by:
    
    getRedoPresentationName在接口 UndoableEdit
    
    重写：
    
    getRedoPresentationName在 CompoundEdit
    
    结果
    
    对该编辑的可重写形式的描述
    
    另请参见：
    
    redo() ， CompoundEdit.getRedoPresentationName()
  - undoableEditHappened
```
public void undoableEditHappened(UndoableEditEvent e)
```
    一个UndoableEditListener方法。这将调用addEdit与e.getEdit() 。
    
    Specified by:
    
    undoableEditHappened在接口 UndoableEditListener
    
    参数
    
    e - UndoableEditEvent的 UndoableEditEvent将从
    
    另请参见：
    
    addEdit(javax.swing.undo.UndoableEdit)
  - toString
```
public String toString()
```
    返回显示和标识此对象属性的字符串。
    
    重写：
    
    toString在 CompoundEdit
    
    结果
    
    该对象的字符串表示形式

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class UndoManager

Field Summary

Fields inherited from class javax.swing.undo.CompoundEdit

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

构造方法摘要

方法摘要

Methods inherited from class javax.swing.undo.CompoundEdit

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

Methods inherited from class java.lang.Object

构造方法详细信息

UndoManager

方法详细信息

getLimit

discardAllEdits

trimForLimit

trimEdits

setLimit

editToBeUndone

editToBeRedone

undoTo

redoTo

undoOrRedo

canUndoOrRedo

undo

canUndo

redo

canRedo

addEdit

end

getUndoOrRedoPresentationName

getUndoPresentationName

getRedoPresentationName

undoableEditHappened

toString