javax.swing.undo
Interface UndoableEdit

All Known Implementing Classes:
AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractUndoableEdit, CompoundEdit, DefaultStyledDocument.AttributeUndoableEdit, StateEdit, UndoManager

public interface UndoableEdit

An editing operation that supports undo/redoability.


Method Summary
 boolean addEdit(UndoableEdit edit)
          Incorporates another editing action into this one, thus forming a combined action.
 boolean canRedo()
          Determines whether it would be possible to redo this editing action.
 boolean canUndo()
          Determines whether it would be possible to undo this editing action.
 void die()
          Informs this edit action that it will no longer be used.
 String getPresentationName()
          Returns a human-readable, localized name that describes this editing action and can be displayed to the user.
 String getRedoPresentationName()
          Returns the redo presentation name.
 String getUndoPresentationName()
          Returns the undo presentation name.
 boolean isSignificant()
          Determines whether this editing action is significant enough for being seperately undoable by the user.
 void redo()
          Redoes this editing action.
 boolean replaceEdit(UndoableEdit edit)
          Incorporates another editing action into this one, thus forming a combined action that replaces the argument action.
 void undo()
          Undoes this editing action.
 

Method Detail

addEdit

boolean addEdit(UndoableEdit edit)
Incorporates another editing action into this one, thus forming a combined action.

Parameters:
edit - the editing action to be incorporated.
Returns:
true if the edit was combined successfully, and false if it could not be combined.

canRedo

boolean canRedo()
Determines whether it would be possible to redo this editing action.

Returns:
true to indicate that this action can be redone, false otherwise.
See Also:
redo(), canUndo()

canUndo

boolean canUndo()
Determines whether it would be possible to undo this editing action.

Returns:
true to indicate that this action can be undone, false otherwise.
See Also:
undo(), canRedo()

die

void die()
Informs this edit action that it will no longer be used. Some actions might use this information to release resources, for example open files. Called by UndoManager before this action is removed from the edit queue.


getPresentationName

String getPresentationName()
Returns a human-readable, localized name that describes this editing action and can be displayed to the user.

Returns:
The presentation name.

getRedoPresentationName

String getRedoPresentationName()
Returns the redo presentation name.

Returns:
The redo presentation name.

getUndoPresentationName

String getUndoPresentationName()
Returns the undo presentation name.

Returns:
The undo presentation name.

isSignificant

boolean isSignificant()
Determines whether this editing action is significant enough for being seperately undoable by the user. A typical significant action would be the resizing of an object. However, changing the selection in a text document would usually not be considered significant.

Returns:
true to indicate that the action is significant enough for being separately undoable, or false otherwise.

redo

void redo()
          throws CannotRedoException
Redoes this editing action.

Throws:
CannotRedoException - if the edit cannot be undone.
See Also:
canRedo(), undo()

replaceEdit

boolean replaceEdit(UndoableEdit edit)
Incorporates another editing action into this one, thus forming a combined action that replaces the argument action.

Parameters:
edit - the editing action to be replaced.
Returns:
true if the edit is successfully replaced, and false otherwise.

undo

void undo()
          throws CannotUndoException
Undoes this editing action.

Throws:
CannotUndoException - if the edit cannot be undone.
See Also:
canUndo(), redo()