org.openide.awt
Interface UndoRedo

All Known Implementing Classes:

UndoRedo.Manager, UndoRedo.Empty

public interface UndoRedo

Undo and Redo manager for top components and workspace elements. It allows UndoAction and RedoAction to listen to editing changes of active components and to changes in their ability to do undo and redo.

See Also:

UndoAction, RedoAction, TopComponent.getUndoRedo()

Inner Class Summary

static class	UndoRedo.Empty Empty implementation that does not support any undoable edits.
static class	UndoRedo.Manager An undo manager which fires a change event each time it consumes a new undoable edit.

Field Summary

static UndoRedo

NONE Empty implementation that does not allow any undo or redo actions.

Method Summary

void	addChangeListener(ChangeListener l) Add a change listener.
boolean	canRedo() Test whether the component currently has undone edits which may be redone.
boolean	canUndo() Test whether the component currently has edits which may be undone.
String	getRedoPresentationName() Get a human-presentable name describing the redo operation.
String	getUndoPresentationName() Get a human-presentable name describing the undo operation.
void	redo() Redo a previously undone edit.
void	removeChangeListener(ChangeListener l) Remove a change listener.
void	undo() Undo an edit.

Field Detail

NONE

public static final UndoRedo NONE

Empty implementation that does not allow any undo or redo actions.

Method Detail

canUndo

public boolean canUndo()

Test whether the component currently has edits which may be undone.

Returns:

true if undo is allowed

canRedo

public boolean canRedo()

Test whether the component currently has undone edits which may be redone.

Returns:

true if redo is allowed

undo

public void undo()
          throws CannotUndoException

Undo an edit.

Throws:

CannotUndoException - if it fails

redo

public void redo()
          throws CannotRedoException

Redo a previously undone edit.

Throws:

CannotRedoException - if it fails

addChangeListener

public void addChangeListener(ChangeListener l)

Add a change listener. The listener will be notified every time the undo/redo ability of this object changes.

Parameters:

l - the listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Remove a change listener.

Parameters:

l - the listener to remove

See Also:

addChangeListener(javax.swing.event.ChangeListener)

getUndoPresentationName

public String getUndoPresentationName()

Get a human-presentable name describing the undo operation.

Returns:

the name

getRedoPresentationName

public String getRedoPresentationName()

Get a human-presentable name describing the redo operation.

Returns:

the name