|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An object representing an edit that has been done, and that can be undone and redone.
Method Summary | |
boolean |
addEdit(UndoableEdit anEdit)
This UndoableEdit should absorb anEdit
if it can. |
boolean |
canRedo()
True if it is still possible to redo this operation. |
boolean |
canUndo()
True if it is still possible to undo this operation. |
void |
die()
May be sent to inform an edit that it should no longer be used. |
String |
getPresentationName()
Provides a localized, human readable description of this edit suitable for use in, say, a change log. |
String |
getRedoPresentationName()
Provides a localized, human readable description of the redoable form of this edit, e.g. |
String |
getUndoPresentationName()
Provides a localized, human readable description of the undoable form of this edit, e.g. |
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. |
void |
redo()
Re-apply the edit, assuming that it has been undone. |
boolean |
replaceEdit(UndoableEdit anEdit)
Returns true if this UndoableEdit should replace
anEdit . |
void |
undo()
Undo the edit that was made. |
Method Detail |
public void undo() throws CannotUndoException
CannotUndoException
public boolean canUndo()
public void redo() throws CannotRedoException
CannotRedoException
public boolean canRedo()
public void die()
UndoManager
calls this before it dequeues edits.
Note that this is a one-way operation. There is no "un-die"
method.
CompoundEdit.die()
public boolean addEdit(UndoableEdit anEdit)
UndoableEdit
should absorb anEdit
if it can. Returns true
if 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
.
anEdit
- the edit to be addedpublic boolean replaceEdit(UndoableEdit anEdit)
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().
public boolean isSignificant()
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.
public String getPresentationName()
public String getUndoPresentationName()
getDescription
.
public String getRedoPresentationName()
getPresentationName
.
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.