Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.undo.AbstractUndoableEdit

java.lang.Object
    |
    +----java.awt.swing.undo.AbstractUndoableEdit
Subclasses:
AbstractDocument.ElementEdit, CompoundEdit, StateEdit

public class AbstractUndoableEdit
extends Object
implements UndoableEdit
An abstract implementation of UndoableEdit, implementing simple responses to all boolean methods in that interface.


Field Summary
static String  RedoName
String returned by getRedoPresentationName()
static String  UndoName
String returned by getUndoPresentationName()
 

Constructor Summary
 AbstractUndoableEdit()
 
 

Method Summary
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()
If getPresentationName() returns "", returns AbstractUndoableEdit.RedoName.
String  getUndoPresentationName()
If getPresentationName() returns "", returns AbstractUndoableEdit.UndoName.
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()
 
void  undo()
Throws CannotUndoException if canUndo() returns false.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UndoName

protected static final String UndoName
String returned by getUndoPresentationName()

RedoName

protected static final String RedoName
String returned by getRedoPresentationName()
Constructor Detail

AbstractUndoableEdit

public AbstractUndoableEdit()
Method Detail

die

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
Implements:
die in interface UndoableEdit

undo

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.
Implements:
undo in interface UndoableEdit
See Also:
canUndo

canUndo

public boolean canUndo()
Returns true if this edit is alive and hasBeenDone is true.
Implements:
canUndo in interface UndoableEdit
See Also:
die, undo, redo

redo

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.
Implements:
redo in interface UndoableEdit
See Also:
canRedo

canRedo

public boolean canRedo()
Returns true if this edit is alive and hasBeenDone is false.
Implements:
canRedo in interface UndoableEdit
See Also:
die, undo, redo

addEdit

public boolean addEdit(UndoableEdit anEdit)
This default implementation returns false.
Implements:
addEdit in interface UndoableEdit
See Also:
addEdit

replaceEdit

public boolean replaceEdit(UndoableEdit anEdit)
This default implementation returns false.
Implements:
replaceEdit in interface UndoableEdit
See Also:
replaceEdit

isSignificant

public boolean isSignificant()
This default implementation returns true.
Implements:
isSignificant in interface UndoableEdit
See Also:
isSignificant

getPresentationName

public String getPresentationName()
This default implementation returns "". Used by getUndoPresentationName() and getRedoPresentationName() to construct the strings they return. Subclasses shoul override to return an appropriate description of the operation this edit represents.
Implements:
getPresentationName in interface UndoableEdit
See Also:
getUndoPresentationName, getRedoPresentationName

getUndoPresentationName

public String getUndoPresentationName()
If getPresentationName() returns "", returns AbstractUndoableEdit.UndoName. Otherwise returns AbstractUndoableEdit.UndoName followed by a space and getPresentationName()
Implements:
getUndoPresentationName in interface UndoableEdit
See Also:
getPresentationName

getRedoPresentationName

public String getRedoPresentationName()
If getPresentationName() returns "", returns AbstractUndoableEdit.RedoName. Otherwise returns AbstractUndoableEdit.RedoName followed by a space and getPresentationName()
Implements:
getRedoPresentationName in interface UndoableEdit
See Also:
getPresentationName

toString

public String toString()
Overrides:
toString in class Object

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.