File	Doc	Category	Size	Date	Package
UndoableEdit.java	API Doc	Java SE 6 API	7531	Tue Jun 10 00:27:02 BST 2008	javax.swing.undo

UndoableEdit

Fields Summary

Constructors Summary

Methods Summary
public boolean	addEdit(javax.swing.undo.UndoableEdit anEdit) Adds an UndoableEdit to this UndoableEdit. This method can be used to coalesce smaller edits into a larger compound edit. For example, text editors typically allow undo operations to apply to words or sentences. The text editor may choose to generate edits on each key event, but allow those edits to be coalesced into a more user-friendly unit, such as a word. In this case, the UndoableEdit would override addEdit to return true when the edits may be coalesced. A return value of true indicates anEdit was incorporated into this edit. A return value of false indicates anEdit may not be incorporated into this edit. Typically the receiver is already in the queue of a UndoManager (or other UndoableEditListener), and is being given a chance to incorporate anEdit rather than letting it be added to the queue in turn. If true is returned, from now on anEdit must return false from canUndo and canRedo, and must throw the appropriate exception on undo or redo. param anEdit the edit to be added return true if anEdit may be incorporated into this edit
public boolean	canRedo() Returns true if this edit may be redone. return true if this edit may be redone
public boolean	canUndo() Returns true if this edit may be undone. return true if this edit may be undone
public void	die() Informs the edit that it should no longer be used. Once an UndoableEdit has been marked as dead it can no longer be undone or redone. This is a useful hook for cleaning up state no longer needed once undoing or redoing is impossible--for example, deleting file resources used by objects that can no longer be undeleted. UndoManager calls this before it dequeues edits. Note that this is a one-way operation. There is no "un-die" method. see CompoundEdit#die
public java.lang.String	getPresentationName() Returns a localized, human-readable description of this edit, suitable for use in a change log, for example. return description of this edit
public java.lang.String	getRedoPresentationName() Returns a localized, human-readable description of the redoable form of this edit, suitable for use as a Redo menu item, for example. This is typically derived from getPresentationName. return a description of the redoable form of this edit
public java.lang.String	getUndoPresentationName() Returns a localized, human-readable description of the undoable form of this edit, suitable for use as an Undo menu item, for example. This is typically derived from getPresentationName. return a description of the undoable form of this edit
public boolean	isSignificant() Returns true if this edit is considered significant. A significant edit is typically an edit that should be presented to the user, perhaps on a menu item or tooltip. The UndoManager will undo, or redo, all insignificant edits to the next significant edit. return true if this edit is significant
public void	redo() Re-applies the edit. throws CannotRedoException if this edit can not be redone
public boolean	replaceEdit(javax.swing.undo.UndoableEdit anEdit) Returns true if this UndoableEdit should replace anEdit. This method is used by CompoundEdit and the UndoManager; it is called if anEdit could not be added to the current edit (addEdit returns false). This method provides a way for an edit to replace an existing edit. This message is the opposite of addEdit--anEdit has typically already been queued in an UndoManager (or other UndoableEditListener), and the receiver is being given a chance to take its place. If true is returned, from now on anEdit must return false from canUndo() and canRedo(), and must throw the appropriate exception on undo() or redo(). param anEdit the edit that replaces the current edit return true if this edit should replace anEdit
public void	undo() Undo the edit. throws CannotUndoException if this edit can not be undone