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 void die();
/**
* This UndoableEdit
should absorb anEdit
* if it can. Returns true
* if 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
.
UndoableEdit
should replace
* anEdit
. The receiver should incorporate
* anEdit
's state before returning true.
*
* This message is the opposite of addEdit--anEdit has typically
* already been queued in a 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().
*/ public boolean replaceEdit(UndoableEdit anEdit); /** * Returns false if this edit is insignificant--for example one * that maintains the user's selection, but does not change any * model state. This status can be used by an *UndoableEditListener
* (like UndoManager) when deciding which UndoableEdits to present
* to the user as Undo/Redo options, and which to perform as side
* effects of undoing or redoing other events.
*/
public boolean isSignificant();
/**
* Provides a localized, human readable description of this edit
* suitable for use in, say, a change log.
*/
public String getPresentationName();
/**
* Provides a localized, human readable description of the undoable
* form of this edit, e.g. for use as an Undo menu item. Typically
* derived from getDescription
.
*/
public String getUndoPresentationName();
/**
* Provides a localized, human readable description of the redoable
* form of this edit, e.g. for use as a Redo menu item. Typically
* derived from getPresentationName
.
*/
public String getRedoPresentationName();
}