javax.swing.undo
Interface UndoableEdit

All Known Implementing Classes:
AbstractDocument.DefaultDocumentEvent sample code for javax.swing.text.AbstractDocument.DefaultDocumentEvent definition code for javax.swing.text.AbstractDocument.DefaultDocumentEvent , AbstractDocument.ElementEdit sample code for javax.swing.text.AbstractDocument.ElementEdit definition code for javax.swing.text.AbstractDocument.ElementEdit , AbstractUndoableEdit sample code for javax.swing.undo.AbstractUndoableEdit definition code for javax.swing.undo.AbstractUndoableEdit , CompoundEdit sample code for javax.swing.undo.CompoundEdit definition code for javax.swing.undo.CompoundEdit , DefaultStyledDocument.AttributeUndoableEdit sample code for javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit definition code for javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit , StateEdit sample code for javax.swing.undo.StateEdit definition code for javax.swing.undo.StateEdit , UndoManager sample code for javax.swing.undo.UndoManager definition code for javax.swing.undo.UndoManager

public interface UndoableEdit

An object representing an edit that has been done, and that can be undone and redone.


Method Summary
 boolean addEdit sample code for javax.swing.undo.UndoableEdit.addEdit(javax.swing.undo.UndoableEdit) definition code for javax.swing.undo.UndoableEdit.addEdit(javax.swing.undo.UndoableEdit) (UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  anEdit)
          This UndoableEdit should absorb anEdit if it can.
 boolean canRedo sample code for javax.swing.undo.UndoableEdit.canRedo() definition code for javax.swing.undo.UndoableEdit.canRedo() ()
          True if it is still possible to redo this operation.
 boolean canUndo sample code for javax.swing.undo.UndoableEdit.canUndo() definition code for javax.swing.undo.UndoableEdit.canUndo() ()
          True if it is still possible to undo this operation.
 void die sample code for javax.swing.undo.UndoableEdit.die() definition code for javax.swing.undo.UndoableEdit.die() ()
          May be sent to inform an edit that it should no longer be used.
 String sample code for java.lang.String definition code for java.lang.String getPresentationName sample code for javax.swing.undo.UndoableEdit.getPresentationName() definition code for javax.swing.undo.UndoableEdit.getPresentationName() ()
          Provides a localized, human readable description of this edit suitable for use in, say, a change log.
 String sample code for java.lang.String definition code for java.lang.String getRedoPresentationName sample code for javax.swing.undo.UndoableEdit.getRedoPresentationName() definition code for javax.swing.undo.UndoableEdit.getRedoPresentationName() ()
          Provides a localized, human readable description of the redoable form of this edit, e.g.
 String sample code for java.lang.String definition code for java.lang.String getUndoPresentationName sample code for javax.swing.undo.UndoableEdit.getUndoPresentationName() definition code for javax.swing.undo.UndoableEdit.getUndoPresentationName() ()
          Provides a localized, human readable description of the undoable form of this edit, e.g.
 boolean isSignificant sample code for javax.swing.undo.UndoableEdit.isSignificant() definition code for javax.swing.undo.UndoableEdit.isSignificant() ()
          Returns false if this edit is insignificant--for example one that maintains the user's selection, but does not change any model state.
 void redo sample code for javax.swing.undo.UndoableEdit.redo() definition code for javax.swing.undo.UndoableEdit.redo() ()
          Re-apply the edit, assuming that it has been undone.
 boolean replaceEdit sample code for javax.swing.undo.UndoableEdit.replaceEdit(javax.swing.undo.UndoableEdit) definition code for javax.swing.undo.UndoableEdit.replaceEdit(javax.swing.undo.UndoableEdit) (UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  anEdit)
          Returns true if this UndoableEdit should replace anEdit.
 void undo sample code for javax.swing.undo.UndoableEdit.undo() definition code for javax.swing.undo.UndoableEdit.undo() ()
          Undo the edit that was made.
 

Method Detail

undo sample code for javax.swing.undo.UndoableEdit.undo() definition code for javax.swing.undo.UndoableEdit.undo()

void undo()
          throws CannotUndoException sample code for javax.swing.undo.CannotUndoException definition code for javax.swing.undo.CannotUndoException 
Undo the edit that was made.

Throws:
CannotUndoException sample code for javax.swing.undo.CannotUndoException definition code for javax.swing.undo.CannotUndoException

canUndo sample code for javax.swing.undo.UndoableEdit.canUndo() definition code for javax.swing.undo.UndoableEdit.canUndo()

boolean canUndo()
True if it is still possible to undo this operation.


redo sample code for javax.swing.undo.UndoableEdit.redo() definition code for javax.swing.undo.UndoableEdit.redo()

void redo()
          throws CannotRedoException sample code for javax.swing.undo.CannotRedoException definition code for javax.swing.undo.CannotRedoException 
Re-apply the edit, assuming that it has been undone.

Throws:
CannotRedoException sample code for javax.swing.undo.CannotRedoException definition code for javax.swing.undo.CannotRedoException

canRedo sample code for javax.swing.undo.UndoableEdit.canRedo() definition code for javax.swing.undo.UndoableEdit.canRedo()

boolean canRedo()
True if it is still possible to redo this operation.


die sample code for javax.swing.undo.UndoableEdit.die() definition code for javax.swing.undo.UndoableEdit.die()

void die()
May be sent to inform an edit that it should no longer be used. 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 Also:
CompoundEdit.die() sample code for javax.swing.undo.CompoundEdit.die() definition code for javax.swing.undo.CompoundEdit.die()

addEdit sample code for javax.swing.undo.UndoableEdit.addEdit(javax.swing.undo.UndoableEdit) definition code for javax.swing.undo.UndoableEdit.addEdit(javax.swing.undo.UndoableEdit)

boolean addEdit(UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  anEdit)
This UndoableEdit should absorb anEdit if it can. Returns true if has been incorporated, false if it has not.

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.

Parameters:
anEdit - the edit to be added

replaceEdit sample code for javax.swing.undo.UndoableEdit.replaceEdit(javax.swing.undo.UndoableEdit) definition code for javax.swing.undo.UndoableEdit.replaceEdit(javax.swing.undo.UndoableEdit)

boolean replaceEdit(UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  anEdit)
Returns true if this 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().


isSignificant sample code for javax.swing.undo.UndoableEdit.isSignificant() definition code for javax.swing.undo.UndoableEdit.isSignificant()

boolean isSignificant()
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.


getPresentationName sample code for javax.swing.undo.UndoableEdit.getPresentationName() definition code for javax.swing.undo.UndoableEdit.getPresentationName()

String sample code for java.lang.String definition code for java.lang.String  getPresentationName()
Provides a localized, human readable description of this edit suitable for use in, say, a change log.


getUndoPresentationName sample code for javax.swing.undo.UndoableEdit.getUndoPresentationName() definition code for javax.swing.undo.UndoableEdit.getUndoPresentationName()

String sample code for java.lang.String definition code for java.lang.String  getUndoPresentationName()
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.


getRedoPresentationName sample code for javax.swing.undo.UndoableEdit.getRedoPresentationName() definition code for javax.swing.undo.UndoableEdit.getRedoPresentationName()

String sample code for java.lang.String definition code for java.lang.String  getRedoPresentationName()
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.