Home » openjdk-7 » javax » swing » undo » [javadoc | source]
javax.swing.undo
public class: AbstractUndoableEdit [javadoc | source]
java.lang.Object
   javax.swing.undo.AbstractUndoableEdit

All Implemented Interfaces:
    UndoableEdit, Serializable

An abstract implementation of UndoableEdit, implementing simple responses to all boolean methods in that interface.
Field Summary
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. 
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. 
 boolean hasBeenDone    Defaults to true; becomes false if this edit is undone, true again if it is redone. 
 boolean alive    True if this edit has not received die; defaults to true
Constructor:
 public AbstractUndoableEdit() 
Method from javax.swing.undo.AbstractUndoableEdit Summary:
addEdit,   canRedo,   canUndo,   die,   getPresentationName,   getRedoPresentationName,   getUndoPresentationName,   isSignificant,   redo,   replaceEdit,   toString,   undo
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.undo.AbstractUndoableEdit Detail:
 public boolean addEdit(UndoableEdit anEdit) 
    This default implementation returns false.
 public boolean canRedo() 
    Returns true if this edit is alive and hasBeenDone is false.
 public boolean canUndo() 
    Returns true if this edit is alive and hasBeenDone is true.
 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.
 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.
 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.
 public boolean isSignificant() 
    This default implementation returns true.
 public  void redo() throws CannotRedoException 
    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.
 public boolean replaceEdit(UndoableEdit anEdit) 
    This default implementation returns false.
 public String toString() 
    Returns a string that displays and identifies this object's properties.
 public  void undo() throws CannotUndoException 
    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.