com.qoppa.pdfNotes.undo

Interface UndoManager

public interface UndoManager

UndoManager manages a list of undo actions, providing a way to undo or redo the appropriate edits.

A built-in implementation of this class is provided. Users to not need to implement this interface. A PDFNotesBean contains an instance of the UndoManager and can be referenced with PDFNotesBean.getUndoManager().

Author:

Qoppa Software

See Also:

PDFNotesBean.getUndoManager()

Method Summary

Modifier and Type	Method and Description
void	addUndoListener(UndoListener listener) Registers an UndoListener to be notified when the undo action list is modified.
void	clearUndoList() Removes all undo and redo UndoActions from the list.
UndoAction	getNextRedoAction() Returns the next redo UndoAction.
UndoAction	getNextUndoAction() Returns the next undo UndoAction.
void	redo() Causes the next redo UndoAction to be executed.
void	setEnabled(boolean enabled) Enables or disables the UndoManager.
void	undo() Causes the next undo UndoAction to be executed.

Method Detail

addUndoListener

void addUndoListener(UndoListener listener)

Registers an UndoListener to be notified when the undo action list is modified.

Parameters:

listener - the UndoListener to register

undo

void undo()

Causes the next undo UndoAction to be executed.

redo

void redo()

Causes the next redo UndoAction to be executed.

clearUndoList

void clearUndoList()

Removes all undo and redo UndoActions from the list.

setEnabled

void setEnabled(boolean enabled)

Enables or disables the UndoManager. By default, the UndoManager is on. If there are memory concerns, the UndoManager can be disabled so that undo and redo UndoActions are no longer stored in memory and the current undo list is also cleared.

Parameters:

enabled - Set false to disable the UndoManager or true to enable it.

getNextUndoAction

UndoAction getNextUndoAction()

Returns the next undo UndoAction.

Returns:

the next undo UndoAction

getNextRedoAction

UndoAction getNextRedoAction()

Returns the next redo UndoAction.

Returns:

the next redo UndoAction