public class

AbstractUndoableEdit

extends Object
implements Serializable UndoableEdit
java.lang.Object
   ↳ javax.swing.undo.AbstractUndoableEdit
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

An abstract implementation of UndoableEdit, implementing simple responses to all boolean methods in that interface.

Summary

Constants
String RedoName String returned by getRedoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used.
String UndoName String returned by getUndoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used.
Public Constructors
AbstractUndoableEdit()
Creates an AbstractUndoableEdit which defaults hasBeenDone and alive to true.
Public Methods
boolean addEdit(UndoableEdit anEdit)
This default implementation returns false.
boolean canRedo()
Returns true if this edit is alive and hasBeenDone is false.
boolean canUndo()
Returns true if this edit is alive and hasBeenDone is true.
void die()
Sets alive to false.
String getPresentationName()
This default implementation returns "".
String getRedoPresentationName()
Retreives the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName.
String getUndoPresentationName()
Retreives the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName.
boolean isSignificant()
This default implementation returns true.
void redo()
Throws CannotRedoException if canRedo returns false.
boolean replaceEdit(UndoableEdit anEdit)
This default implementation returns false.
String toString()
Returns a string that displays and identifies this object's properties.
void undo()
Throws CannotUndoException if canUndo returns false.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.swing.undo.UndoableEdit

Constants

protected static final String RedoName

String returned by getRedoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used. This value is now localized and comes from the defaults table with key AbstractUndoableEdit.redoText.

See Also
Constant Value: "Redo"

protected static final String UndoName

String returned by getUndoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used. This value is now localized and comes from the defaults table with key AbstractUndoableEdit.undoText.

See Also
Constant Value: "Undo"

Public Constructors

public AbstractUndoableEdit ()

Creates an AbstractUndoableEdit which defaults hasBeenDone and alive to true.

Public Methods

public boolean addEdit (UndoableEdit anEdit)

This default implementation returns false.

Parameters
anEdit the edit to be added
Returns
  • false
See Also

public boolean canRedo ()

Returns true if this edit is alive and hasBeenDone is false.

Returns
  • true if this edit is alive and hasBeenDone is false
See Also

public boolean canUndo ()

Returns true if this edit is alive and hasBeenDone is true.

Returns
  • true if this edit is alive and hasBeenDone is true
See Also

public void die ()

Sets alive to false. Note that this is a one way operation; dead edits cannot be resurrected. Sending undo or redo to a dead edit results in an exception being thrown.

Typically an edit is killed when it is consolidated by another edit's addEdit or replaceEdit method, or when it is dequeued from an UndoManager.

public String getPresentationName ()

This default implementation returns "". Used by getUndoPresentationName and getRedoPresentationName to construct the strings they return. Subclasses should override to return an appropriate description of the operation this edit represents.

Returns
  • the empty string ""
See Also

public String getRedoPresentationName ()

Retreives the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.

Returns
  • the value from the defaults table with key AbstractUndoableEdit.redoText, followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.
See Also

public String getUndoPresentationName ()

Retreives the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.

Returns
  • the value from the defaults table with key AbstractUndoableEdit.undoText, followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.
See Also

public boolean isSignificant ()

This default implementation returns true.

Returns
  • true
See Also

public void redo ()

Throws CannotRedoException if canRedo returns false. Sets hasBeenDone to true. Subclasses should override to redo the operation represented by this edit. Override should begin with a call to super.

Throws
CannotRedoException if canRedo returns false
See Also

public boolean replaceEdit (UndoableEdit anEdit)

This default implementation returns false.

Parameters
anEdit the edit to replace
Returns
  • false
See Also

public String toString ()

Returns a string that displays and identifies this object's properties.

Returns
  • a String representation of this object

public void undo ()

Throws CannotUndoException if canUndo returns false. Sets hasBeenDone to false. Subclasses should override to undo the operation represented by this edit. Override should begin with a call to super.

Throws
CannotUndoException if canUndo returns false
See Also